ci-fix: embed latest release notes in nugets, push version numbers

egil · egil · commit 886055443576 · 2023-11-24T17:45:43.000Z
diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml
@@ -15,6 +15,13 @@ on:
 
   workflow_dispatch:
 
+env:
+  VSTEST_CONNECTION_TIMEOUT: 180
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_NOLOGO: true
+  DOTNET_SYSTEM_CONSOLE_ALLOW_ANSI_COLOR_REDIRECTION: 1
+  TERM: xterm
+
 jobs:
   deploy:
     name: 📃 Deploy new version bunit.dev
@@ -55,10 +62,11 @@ jobs:
 
       - name: 🛠️ Update tokens in project files
         uses: cschleiden/replace-tokens@v1
-        env:
-          RELEASE-VERSION: ${{ steps.changelog_reader.outputs.version }}
         with:
-          files: '["docs/site/docfx.json", "docs/site/*.md", "docs/**/*.md", "docs/**/*.tmpl.partial", "*.csproj", "**/*.csproj"]'
+          files: '["docs/site/*.md", "docs/**/*.md", "docs/**/*.tmpl.partial", "*.csproj", "**/*.csproj", "src/Directory.Build.props"]'
+        env:
+          RELEASE_VERSION: ${{ steps.changelog_reader.outputs.version }}
+          RELEASE_NOTES: ${{ steps.changelog_reader.outputs.changes }}
 
       - name: ⚙️ Setup dotnet versions
         uses: actions/setup-dotnet@v3
diff --git a/.github/workflows/prepare-release.yml b/.github/workflows/prepare-release.yml
@@ -8,13 +8,13 @@ on:
         description: 'The version increment. Allowed values are "major" and "minor".'
         required: true
         default: 'minor'
-        
-jobs:  
+
+jobs:
   prepare-release:
     name: 🚚 Prepare new release
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main' && contains(fromJson('["major","minor"]'), github.event.inputs.versionIncrement)
-    steps:   
+    steps:
       - name: 🛒 Checkout repository
         uses: actions/checkout@v4
         with:
@@ -27,39 +27,40 @@ jobs:
         with:
           version: Unreleased
           path: ./CHANGELOG.md
-      
+
       - name: ☑ Check that release contains changes
         if: steps.changelog_reader.outputs.changes == ''
         run: |
           echo "::error file=CHANGELOG.md::The unreleased section in the changelog is empty. Nothing to release."
           exit 1
+
       - name: ⚙️ Import GPG key
         id: import_gpg
         uses: crazy-max/ghaction-import-gpg@v6
         with:
           gpg_private_key: ${{ secrets.BUNIT_BOT_GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.BUNIT_BOT_GPG_KEY_PASSPHRASE }}
-      
+
       - name: ⚙️ Setup CI GIT
         run: |
           git config user.name "${{ steps.import_gpg.outputs.name }}"
           git config user.email ${{ steps.import_gpg.outputs.email }}
           git config --global user.signingkey ${{ steps.import_gpg.outputs.keyid }}
-          git config --global commit.gpgsign true   
-      
+          git config --global commit.gpgsign true
+
       - name: ⚙️ Setup GIT versioning
         uses: dotnet/nbgv@v0.4.1
         with:
           setAllVars: true
-          
+
       - name: 🛠️ Increment version.json on main + create release branch
         id: versions
         run: |
-          nbgv prepare-release --versionIncrement ${{ github.event.inputs.versionIncrement }}          
+          nbgv prepare-release --versionIncrement ${{ github.event.inputs.versionIncrement }}
           echo "MAIN_VERSION_COMMIT_MESSAGE=$(git log --format=%B -n 1 --skip 1)" >> $GITHUB_OUTPUT
           git checkout release/v$NBGV_MajorMinorVersion
           echo "RELEASE_VERSION_COMMIT_MESSAGE=$(git log --format=%B -n 1)" >> $GITHUB_OUTPUT
-      
+
       # Workaround since nbgv prepare-release does not sign commits.
       # This undo's the commits, keeps the version changes, and commits again with signing
       # with the saved commit messages from previous step.
@@ -69,16 +70,16 @@ jobs:
           git checkout release/v$NBGV_MajorMinorVersion
           git reset --soft HEAD~1
           git commit -S -m "${{ steps.versions.outputs.RELEASE_VERSION_COMMIT_MESSAGE }}"
-          
+
           git checkout main
           git reset --hard HEAD~1
           git reset --soft HEAD~1
           git commit -S -m "${{ steps.versions.outputs.MAIN_VERSION_COMMIT_MESSAGE }}"
           git merge -S -X ours release/v$NBGV_MajorMinorVersion
-          
+
       - name: ⏩ Push version.json updates to main
         run: git push origin main
-        
+
       - name: ⏩ Push release branch to origin
         run: git push origin release/v$NBGV_MajorMinorVersion
 
@@ -92,7 +93,7 @@ jobs:
           title: Release of new ${{ github.event.inputs.versionIncrement }} version v${{ env.NBGV_MajorMinorVersion }}
           body: |
             This PR was created in response to a manual trigger of the [prepare-release workflow](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}).
-            
+
             Merging this PR will create a GitHub Release and push new packages to NuGet.
-            
+
             **NOTE:** Only small fixes should be added to this PR at this point. If you need to make minor or major changes, close the PR and make those changes to ${{ github.ref }} instead, and run the prepare-release workflow again once you are done.
diff --git a/.github/workflows/release-preview.yml b/.github/workflows/release-preview.yml
@@ -7,6 +7,13 @@ on:
     types: [completed]
     branches: [main, v2]
 
+env:
+  VSTEST_CONNECTION_TIMEOUT: 180
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_NOLOGO: true
+  DOTNET_SYSTEM_CONSOLE_ALLOW_ANSI_COLOR_REDIRECTION: 1
+  TERM: xterm
+
 jobs:
   release-preview:
     if: github.event_name == 'workflow_dispatch' || (github.ref == 'refs/heads/main' && ${{ github.event.workflow_run.conclusion == 'success' }}) || (github.ref == 'refs/heads/v2' && ${{ github.event.workflow_run.conclusion == 'success' }})
@@ -31,15 +38,20 @@ jobs:
             7.0.x
             8.0.x
 
-      - name: 🎨 Setup color
-        run: |
-          echo "DOTNET_SYSTEM_CONSOLE_ALLOW_ANSI_COLOR_REDIRECTION=1" >> $GITHUB_ENV
-          echo "TERM=xterm" >> $GITHUB_ENV
+      - name: 🛠️ Get Changelog Entry
+        id: changelog_reader
+        uses: mindsers/changelog-reader-action@v2
+        with:
+          version: Unreleased
+          path: ./CHANGELOG.md
 
       - name: 🛠️ Update tokens in project files
         uses: cschleiden/replace-tokens@v1
         with:
-          files: '["*.csproj", "**/*.csproj"]'
+          files: '["docs/site/*.md", "docs/**/*.md", "docs/**/*.tmpl.partial", "*.csproj", "**/*.csproj", "src/Directory.Build.props"]'
+        env:
+          RELEASE_VERSION: ${{ env.NBGV_NuGetPackageVersion }}
+          RELEASE_NOTES: ${{ steps.changelog_reader.outputs.changes }}
 
       - name: 🛠️ Packing library in release mode
         run: |
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -12,6 +12,13 @@ on:
 
   workflow_dispatch:
 
+env:
+  VSTEST_CONNECTION_TIMEOUT: 180
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_NOLOGO: true
+  DOTNET_SYSTEM_CONSOLE_ALLOW_ANSI_COLOR_REDIRECTION: 1
+  TERM: xterm
+
 jobs:
   release:
     name: 🎁 Publish new release
@@ -27,19 +34,6 @@ jobs:
           fetch-depth: 0
           token: ${{ secrets.BUNIT_BOT_TOKEN }}
 
-      - name: 🛠️ Get Changelog Entry
-        id: changelog_reader
-        uses: mindsers/changelog-reader-action@v2
-        with:
-          version: Unreleased
-          path: ./CHANGELOG.md
-
-      - name: ☑ Check that release contains changes
-        if: steps.changelog_reader.outputs.changes == ''
-        run: |
-          echo "::error file=CHANGELOG.md::The unreleased section in the changelog is empty. Nothing to release."
-          exit 1
-
       - name: ⚙️ Import GPG key
         id: import_gpg
         uses: crazy-max/ghaction-import-gpg@v6
@@ -86,10 +80,20 @@ jobs:
           git commit -S -m "Updated CHANGELOG.md for ${{ env.NBGV_SimpleVersion }} release"
           echo "RELEASE_COMMIT_HASH=$(git rev-parse stable)" >> $GITHUB_ENV
 
+      - name: 🛠️ Get Changelog Entry
+        id: changelog_reader
+        uses: mindsers/changelog-reader-action@v2
+        with:
+          version: ${{ env.NBGV_SemVer2 }}
+          path: ./CHANGELOG.md
+
       - name: 🛠️ Update tokens in project files
         uses: cschleiden/replace-tokens@v1
         with:
-          files: '["*.csproj", "**/*.csproj"]'
+          files: '["docs/site/*.md", "docs/**/*.md", "docs/**/*.tmpl.partial", "*.csproj", "**/*.csproj", "src/Directory.Build.props"]'
+        env:
+          RELEASE_VERSION: ${{ env.NBGV_NuGetPackageVersion }}
+          RELEASE_NOTES: ${{ steps.changelog_reader.outputs.changes }}
 
       - name: 🛠️ Packing library in release mode
         run: |
diff --git a/.github/workflows/verification.yml b/.github/workflows/verification.yml
@@ -55,10 +55,20 @@ jobs:
       with:
         setAllVars: true
 
-    - name: 🍥 Replace tokens in files
+    - name: 🛠️ Get Changelog Entry
+      id: changelog_reader
+      uses: mindsers/changelog-reader-action@v2
+      with:
+        version: Unreleased
+        path: ./CHANGELOG.md
+
+    - name: 🛠️ Update tokens in project files
       uses: cschleiden/replace-tokens@v1
       with:
-        files: '["docs/site/*.md", "docs/**/*.md", "docs/**/*.tmpl.partial", "*.csproj", "**/*.csproj"]'
+        files: '["docs/site/*.md", "docs/**/*.md", "docs/**/*.tmpl.partial", "*.csproj", "**/*.csproj", "src/Directory.Build.props"]'
+      env:
+        RELEASE_VERSION: ${{ env.NBGV_NuGetPackageVersion }}
+        RELEASE_NOTES: ${{ steps.changelog_reader.outputs.changes }}
 
     # Create the NuGet package in the folder from the environment variable NuGetDirectory
     - run: |
@@ -137,6 +147,10 @@ jobs:
     runs-on: ubuntu-latest
     needs: [ create-nuget ]
     steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Get all history to allow automatic versioning using MinVer
+
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
 
@@ -152,32 +166,31 @@ jobs:
 
       - name: ✳ Install bUnit template
         run: |
-          dotnet new --install bunit.template::${NBGV_NuGetPackageVersion} --nuget-source ${{ env.NUGET_DIRECTORY }}
+          dotnet new install bunit.template::${NBGV_NuGetPackageVersion} --nuget-source ${{ env.NUGET_DIRECTORY }}
 
       - name: ✔ Verify xUnit template
         run: |
           dotnet new bunit --no-restore -o ${{ github.workspace }}/TemplateTestXunit
           echo '<?xml version="1.0" encoding="utf-8"?><Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"></Project>' >> ${{ github.workspace }}/TemplateTestXunit/Directory.Build.props
-          dotnet restore ${{ github.workspace }}/TemplateTestXunit --source https://api.nuget.org/v3/index.json --source ${{ github.workspace }}/packages
+          dotnet restore ${{ github.workspace }}/TemplateTestXunit --source https://api.nuget.org/v3/index.json --source ${{ env.NUGET_DIRECTORY }}
           dotnet test ${{ github.workspace }}/TemplateTestXunit
 
       - name: ✔ Verify NUnit template
         run: |
           dotnet new bunit --framework nunit --no-restore -o ${{ github.workspace }}/TemplateTestNunit
           echo '<?xml version="1.0" encoding="utf-8"?><Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"></Project>' >> ${{ github.workspace }}/TemplateTestNunit/Directory.Build.props
-          dotnet restore ${{ github.workspace }}/TemplateTestNunit --source https://api.nuget.org/v3/index.json --source ${{ github.workspace }}/packages
+          dotnet restore ${{ github.workspace }}/TemplateTestNunit --source https://api.nuget.org/v3/index.json --source ${{ env.NUGET_DIRECTORY }}
           dotnet test ${{ github.workspace }}/TemplateTestNunit
 
       - name: ✔ Verify MSTest template
         run: |
           dotnet new bunit --framework mstest --no-restore -o ${{ github.workspace }}/TemplateTestMstest
           echo '<?xml version="1.0" encoding="utf-8"?><Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"></Project>' >> ${{ github.workspace }}/TemplateTestMstest/Directory.Build.props
-          dotnet restore ${{ github.workspace }}/TemplateTestMstest --source https://api.nuget.org/v3/index.json --source ${{ github.workspace }}/packages
+          dotnet restore ${{ github.workspace }}/TemplateTestMstest --source https://api.nuget.org/v3/index.json --source ${{ env.NUGET_DIRECTORY }}
           dotnet test ${{ github.workspace }}/TemplateTestMstest
 
   validate-docs:
     runs-on: ubuntu-latest
-
     steps:
       - name: 🛒 Checkout repository
         uses: actions/checkout@v4
@@ -208,7 +221,7 @@ jobs:
         run: dotnet build
 
       - name: 🧪 Run sample unit tests
-        run: dotnet test -c release docs/samples/samples.sln
+        run: dotnet test docs/samples/samples.sln
 
       - name: 📄 Build docs
         working-directory: ./docs/site
diff --git a/docs/site/docs/getting-started/create-test-project.md b/docs/site/docs/getting-started/create-test-project.md
@@ -171,7 +171,7 @@ The result should be a test project with a `.csproj` that looks like this (non b
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="bunit" Version="#{RELEASE-VERSION}#" />
+    <PackageReference Include="bunit" Version="#{RELEASE_VERSION}#" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
@@ -200,7 +200,7 @@ The result should be a test project with a `.csproj` that looks like this (non b
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="bunit" Version="#{RELEASE-VERSION}#" />
+    <PackageReference Include="bunit" Version="#{RELEASE_VERSION}#" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.4.2" />
@@ -226,7 +226,7 @@ The result should be a test project with a `.csproj` that looks like this (non b
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="bunit" Version="#{RELEASE-VERSION}#" />
+    <PackageReference Include="bunit" Version="#{RELEASE_VERSION}#" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
     <PackageReference Include="MSTest.TestAdapter" Version="3.0.2" />
     <PackageReference Include="MSTest.TestFramework" Version="3.0.2" />
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -27,12 +27,6 @@
 		<PackageValidationBaselineVersion>1.25.3</PackageValidationBaselineVersion>
 	</PropertyGroup>
 
-	<Target Name="SetPackageReleaseNotes" BeforeTargets="GenerateNuspec">
-		<PropertyGroup>
-			<PackageReleaseNotes>$([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/../../CHANGELOG.md"))</PackageReleaseNotes>
-		</PropertyGroup>
-	</Target>
-
 	<PropertyGroup Label="NuGet package information">
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<RepositoryUrl>https://github.com/bUnit-dev/bUnit</RepositoryUrl>
@@ -46,6 +40,7 @@
 		<PublishRepositoryUrl>true</PublishRepositoryUrl>
 		<PackageIcon>bunit-logo.png</PackageIcon>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
+		<PackageReleaseNotes>#{RELEASE_NOTES}#</PackageReleaseNotes>
 	</PropertyGroup>
 
 	<ItemGroup>
diff --git a/src/bunit.template/template/Company.BlazorTests1.csproj b/src/bunit.template/template/Company.BlazorTests1.csproj
@@ -16,7 +16,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="bunit" Version="#{NBGV_NuGetPackageVersion}#" />
+		<PackageReference Include="bunit" Version="#{RELEASE_VERSION}#" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 		<PackageReference Include="coverlet.collector" Version="6.0.0">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
