build(github): include README in package

.github/actions/pack-and-publish/action.yml

@@ -1,34 +1,36 @@
-name: 'Pack and Publish'
+name: "Pack and Publish"
 
-description: 'Packs and publishes a .NET Library as a build artifact'
+description: "Packs and publishes a .NET Library as a build artifact"
 
 inputs:
   projectPath:
-    description: 'Path to the project file'
+    description: "Path to the project file"
     required: true
   preReleaseVersion:
-    description: 'The pre-release version to use for the NuGet package'
+    description: "The pre-release version to use for the NuGet package"
     required: true
 
 runs:
   using: composite
   steps:
     - name: Create PreRelease Artifact
-      run: dotnet pack ${{ inputs.projectPath }} -c Release --no-build --include-symbols -o ./artifacts/prerelease --version-suffix prerelease-${{ inputs.preReleaseVersion }}
+      run: |
+        cp ./README.md ./src
+        dotnet pack ${{ inputs.projectPath }} -c Release -o ./artifacts/prerelease --version-suffix prerelease-${{ inputs.preReleaseVersion }}
       shell: pwsh
 
-    - name: 'Save prerelease artifact'
+    - name: "Save prerelease artifact"
       uses: actions/upload-artifact@v3
       with:
         name: prerelease
         path: ./artifacts/prerelease/*
 
     - name: Create Release Artifact
-      run: dotnet pack ${{ inputs.projectPath }} -c Release --no-build --include-symbols -o ./artifacts/release
+      run: dotnet pack ${{ inputs.projectPath }} -c Release -o ./artifacts/release
       shell: pwsh
 
-    - name: 'Save release artifact'
+    - name: "Save release artifact"
       uses: actions/upload-artifact@v3
       with:
         name: release
-        path: ./artifacts/release/*
+        path: ./artifacts/release/*

.github/workflows/ci.yml

@@ -41,4 +41,7 @@ jobs:
         run: dotnet test --configuration Release --no-build --no-restore
 
       - name: Build Package
-        run: dotnet build src/templatepack.csproj
+        run: |
+          cp ./README.md ./src
+          dotnet pack ./src/templatepack.csproj -o ./
+        shell: pwsh

.github/workflows/publish.yml

@@ -30,9 +30,6 @@ jobs:
       - name: Test Solution
         run: dotnet test --configuration Release --no-build --no-restore
 
-      - name: Build Package
-        run: dotnet build src/templatepack.csproj
-
       - name: "Pack and Publish"
         uses: ./.github/actions/pack-and-publish
         with:

src/templatepack.csproj

@@ -4,6 +4,7 @@
     <PackageType>Template</PackageType>
     <PackageVersion>1.0.0</PackageVersion>
     <PackageId>XperienceCommunity.DotnetItemTemplates</PackageId>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <Title>Xperience Community - .NET Item Templates</Title>
     <Authors>Sean G. Wright</Authors>
     <Description>.NET CLI Item Templates for Xperience by Kentico projects, usable at the command line or in Visual Studio</Description>
@@ -31,6 +32,8 @@
     <Content Remove="templates\**\node_modules\**" />
 
     <Compile Remove="**\*" />
+
+    <None Include="README.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
 </Project>