Skip to content

Commit 7dad152

Browse files
author
Ghaith Prosoft
committed
Include README in NuGet package and improve workflows
- Removed the `--no-build` flag from the `dotnet pack` command in `publish-nuget.yml` to ensure proper project building during packaging. - Added `publish-nuget.yml` to "Solution Items" in `KitStack.Storage.sln` for better visibility. - Updated `KitStack.AspNetCore.csproj` to include `README.md` in the NuGet package for improved package UX. - Added a new `README.md` file with project overview, usage instructions, and licensing details.
1 parent ac8746c commit 7dad152

4 files changed

Lines changed: 22 additions & 1 deletion

File tree

.github/workflows/publish-nuget.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ jobs:
7171
echo "Packing version: $VERSION"
7272
dotnet pack src/KitStack.AspNetCore/KitStack.AspNetCore.csproj \
7373
-c Release -o ./nupkg \
74-
--no-build \
7574
/p:Version=$VERSION \
7675
/p:IncludeSymbols=true \
7776
/p:SymbolPackageFormat=snupkg

KitStack.Storage.sln

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
2222
Directory.Build.props = Directory.Build.props
2323
Directory.Packages.props = Directory.Packages.props
2424
LICENSE = LICENSE
25+
.github\workflows\publish-nuget.yml = .github\workflows\publish-nuget.yml
2526
README.md = README.md
2627
EndProjectSection
2728
EndProject

src/KitStack.AspNetCore/KitStack.AspNetCore.csproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
1818
<PackageProjectUrl>https://github.com/ghaith100994/KitStack.Storageo</PackageProjectUrl>
1919
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
20+
<!-- Include README in NuGet package for better package UX and symbols validation -->
21+
<PackageReadmeFile>README.md</PackageReadmeFile>
2022
<!-- set true if you want dotnet build to create package -->
2123
</PropertyGroup>
2224

src/KitStack.AspNetCore/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# KitStack.AspNetCore
2+
3+
KitStack.AspNetCore contains ASP.NET Core integration helpers for the KitStack storage providers.
4+
5+
This package provides utilities for serving files, registering fake/in-memory storage for testing,
6+
and wiring up the local filesystem storage implementation when running in development.
7+
8+
Usage
9+
-----
10+
11+
- Register the desired storage provider in `Startup` / `Program`.
12+
- Use the `IFileStorageManager` abstraction to upload and retrieve files.
13+
14+
For full documentation and examples, see the project repository:
15+
https://github.com/ghaith100994/KitStack.Storage
16+
17+
License
18+
-------
19+
Apache-2.0

0 commit comments

Comments
 (0)