#2343 Release 24.1 Beta.1 (#2348)

* The PDF document should display the release version number on the cover page
* Add PowerShell version of docs bulding script aka make.ps1
* Clear all cache items once a PR is closed
* minimal verbosity when releasing
* build.cake Version should be SemVer to release alpha, beta
* build.cake CreateReleaseNotes task: add Honoring and Starring sections to the end of the release notes, which will be published in GitHub Releases and shared with the community via email
* build.cake UnitTests task: single TFM for testing when releasing
* build.cake UnitTests task: Don't skip unit testing just because coverage file is required for Coveralls step. Thus main branch Coveralls badge will be updated
* build.cake PublishGitHubRelease task: Complete release as latest one for main branch (not a beta versions)
* build.cake PublishToNuget task: SkipDuplicate if package exists on NuGet
* build.cake PublishToNuget task: Publish all packs, no skipping & including filters

Author: raman-m

.github/workflows/pr-closed.yml

@@ -15,8 +15,12 @@ jobs:
         run: |
           pr_no="${{ github.event.pull_request.number }}"
           echo Pull request $pr_no cache items to be deleted...
-          gh cache list --ref refs/pull/$pr_no/merge
+          gh cache list --ref refs/pull/$pr_no/merge          
           echo --------------------------------------
-          gh cache list --ref refs/pull/$pr_no/merge --json id --jq '.[].id' | xargs -n1 gh cache delete
+          echo All cache items to be deleted...
+          gh cache list
+          echo --------------------------------------
+          # gh cache list --ref refs/pull/$pr_no/merge --json id --jq '.[].id' | xargs -n1 gh cache delete
+          # Sometimes, items produced by other workflows get reused in the PR workflow
+          gh cache delete --all --succeed-on-no-caches
           echo DONE
-  # To be added

.github/workflows/release.yml

@@ -35,9 +35,9 @@ jobs:
       - name: Build
         run: dotnet build --no-restore ./Ocelot.Release.sln --framework net${{ matrix.dotnet-version }}.0
       - name: Unit Tests
-        run: dotnet test --no-restore --no-build --verbosity normal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
+        run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
       - name: Acceptance Tests
-        run: dotnet test --no-restore --no-build --verbosity normal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
+        run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
 
   build-macos:
     needs: build-windows
@@ -74,9 +74,9 @@ jobs:
       - name: Build
         run: dotnet build --no-restore ./Ocelot.Release.sln --framework net${{ matrix.dotnet-version }}.0
       - name: Unit Tests
-        run: dotnet test --no-restore --no-build --verbosity normal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
+        run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
       - name: Acceptance Tests
-        run: dotnet test --no-restore --no-build --verbosity normal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
+        run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
 
   build-linux:
     needs: build-macos
@@ -117,9 +117,9 @@ jobs:
       - name: Build
         run: dotnet build --no-restore ./Ocelot.Release.sln --framework net${{ matrix.dotnet-version }}.0
       - name: Unit Tests
-        run: dotnet test --no-restore --no-build --verbosity normal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
+        run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
       - name: Acceptance Tests
-        run: dotnet test --no-restore --no-build --verbosity normal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
+        run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }}.0 ./test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
 
   release-cake:
     needs: build-linux
@@ -132,7 +132,7 @@ jobs:
         env:
           # CAKE_RELEASE_MYVAR: ${{ vars.CAKE_RELEASE_MYVAR }}
           # TEMP_KEY: ${{ secrets.TEMP_KEY }} # leaked secret LoL
-          GITHUB_CONTEXT: ${{ toJson(github) }} # see line 142
+          GITHUB_CONTEXT: ${{ toJson(github) }}
         run: |
           echo "github context >>>" # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context
           echo "$GITHUB_CONTEXT"

build.cake

@@ -151,8 +151,8 @@ Task("Version")
 	.Does(() =>
 	{
 		versioning = GetNuGetVersionForCommit();
-		versioning.NuGetVersion ??= (target == Release && IsRunningInCICD())
-		    ? versioning.MajorMinorPatch : versioning.SemVer;
+		versioning.NuGetVersion ??= (target == Release && IsRunningInCICD()) ? versioning.MajorMinorPatch : versioning.SemVer;
+		versioning.NuGetVersion = versioning.SemVer;
 		Information("#########################");
 		Information("# SemVer Information");
 		Information("#========================");
@@ -412,20 +412,20 @@ Task("CreateReleaseNotes")
             }
             return log;
         } // END of IterateCommits
-        // releaseNotes.Add("### Honoring :medal_sports: aka Top Contributors :clap:");
-        // releaseNotes.AddRange(topContributors.Take(3)); // Top 3 only, disabled 'breaker' logic
-        // releaseNotes.Add("");
-        // releaseNotes.Add("### Starring :star: aka Release Influencers :bowtie:");
-        // releaseNotes.AddRange(starring);
-        // releaseNotes.Add("");
-        // releaseNotes.Add($"### Features in Release {releaseVersion}");
-        // releaseNotes.Add("");
-        // releaseNotes.Add("<details><summary>Logbook</summary>");
-        // releaseNotes.Add("");
-        // var commitsHistory = GitHelper($"log --no-merges --date=format:\"%A, %B %d at %H:%M\" --pretty=format:\"- <sub>%h by **%aN** on %ad &rarr;</sub>%n  %s\" {lastRelease}..HEAD");
-        // releaseNotes.AddRange(commitsHistory);
-        // releaseNotes.Add("</details>");
-        //releaseNotes.Add("");
+        releaseNotes.Add("### Honoring :medal_sports: aka Top Contributors :clap:");
+        releaseNotes.AddRange(topContributors.Take(3)); // Top 3 only, disabled 'breaker' logic
+        releaseNotes.Add("");
+        releaseNotes.Add("### Starring :star: aka Release Influencers :bowtie:");
+        releaseNotes.AddRange(starring);
+        releaseNotes.Add("");
+        releaseNotes.Add($"### Features in Release {releaseVersion}");
+        releaseNotes.Add("");
+        releaseNotes.Add("<details><summary>Logbook</summary>");
+        releaseNotes.Add("");
+        var commitsHistory = GitHelper($"log --no-merges --date=format:\"%A, %B %d at %H:%M\" --pretty=format:\"- <sub>%h by **%aN** on %ad &rarr;</sub>%n  %s\" {lastRelease}..HEAD");
+        releaseNotes.AddRange(commitsHistory);
+        releaseNotes.Add("</details>");
+        releaseNotes.Add("");
         WriteReleaseNotes();
 	});
 
@@ -496,7 +496,7 @@ private void WriteReleaseNotes()
 private List<string> GetTFMs()
 {
 	var tfms = AllFrameworks.Split(';').ToList();
-	if (target == "LatestFramework" || target == "UnitTests")
+	if (target == "LatestFramework" || target == "UnitTests" || target == "Release")
     {
         tfms.Clear();
         tfms.Add(LatestFramework);
@@ -508,12 +508,7 @@ Task("UnitTests")
 	.Does(() =>
 	{
 		var verbosity = IsRunningInCICD() ? "minimal" : "normal";
-		if (IsRunningInCICD() && target == Release)
-		{
-			Warning("We are rolling out a release through the CI/CD pipeline, so we won't be running unit tests this time!");
-		 	return;
-		}
-        // Sequential processing as an emulation of Visual Studio Test Explorer
+		// Sequential processing as an emulation of Visual Studio Test Explorer
 		foreach (string tfm in GetTFMs())
 		{
 			var settings = new DotNetTestSettings
@@ -796,7 +791,7 @@ private void PersistVersion(string committedVersion, string newVersion)
 	}
 }
 
-/// Publishes code and symbols packages to nuget feed, based on contents of artifacts file
+// Publishes code and symbols packages to nuget feed, based on contents of artifacts file
 private void PublishPackages(ConvertableDirectoryPath packagesDir, ConvertableFilePath artifactsFile, string feedApiKey, string codeFeedUrl, string symbolFeedUrl)
 {
 		Information($"{nameof(PublishPackages)}: Publishing to NuGet...");
@@ -822,17 +817,17 @@ private void PublishPackages(ConvertableDirectoryPath packagesDir, ConvertableFi
 		var errors = new List<string>();
 		foreach (var artifact in artifacts)
 		{
-            // if (skippable.Exists(x => artifact.StartsWith(x)))
+			// if (skippable.Exists(x => artifact.StartsWith(x)))
+			// 	continue;
+			// if (!includedInTheRelease.Exists(x => artifact.StartsWith(x)))
 			// 	continue;
-            if (!includedInTheRelease.Exists(x => artifact.StartsWith(x)))
-				continue;
 
 			var codePackage = packagesDir + File(artifact);
 			Information($"{nameof(PublishPackages)}: Pushing package " + codePackage + "...");
 			try
 			{
 				DotNetNuGetPush(codePackage,
-					new DotNetNuGetPushSettings { ApiKey = feedApiKey, Source = codeFeedUrl });
+					new DotNetNuGetPushSettings { ApiKey = feedApiKey, Source = codeFeedUrl, SkipDuplicate = true });
 			}
 			catch (Exception e)
 			{
@@ -916,8 +911,8 @@ private void CompleteGitHubRelease(dynamic release)
 	int releaseId = release.id;
 	string url = release.url.ToString();
 	string body = ReleaseNotesAsJson();
-	bool IsPreRelease = true;
-	var json = $"{{ \"tag_name\": \"{versioning.NuGetVersion}\", \"target_commitish\": \"{versioning.BranchName}\", \"name\": \"{versioning.NuGetVersion}\", \"body\": \"{body}\", \"draft\": false, \"prerelease\": {IsPreRelease.ToString().ToLower()} }}";
+	bool isPreRelease = !IsMainBranch();
+	var json = $"{{ \"tag_name\": \"{versioning.NuGetVersion}\", \"target_commitish\": \"{versioning.BranchName}\", \"name\": \"{versioning.NuGetVersion}\", \"body\": \"{body}\", \"draft\": false, \"prerelease\": {isPreRelease.ToString().ToLower()} }}";
 	var request = new System.Net.Http.HttpRequestMessage(new System.Net.Http.HttpMethod("Patch"), url); // $"https://api.github.com/repos/ThreeMammals/Ocelot/releases/{releaseId}");
 	request.Content = new System.Net.Http.StringContent(json, System.Text.Encoding.UTF8, "application/json");
 
@@ -964,10 +959,10 @@ private bool IsRunningOnCircleCI()
 private bool IsRunningInGitHubActions()
 	=> Environment.GetEnvironmentVariable("GITHUB_ACTIONS") == "true";
 
-private bool IsMainOrDevelop()
+private bool IsMainBranch()
 {
 	var br = GetBranchName().ToLower();
-    return br == "main" || br == "develop";
+    return br == "main";
 }
 private string GetBranchName()
 {

docs/conf.py

@@ -9,8 +9,8 @@
 project = 'Ocelot Gateway'
 copyright = ' 2016-2025 Three Mammals'
 author = 'Tom Gardham-Pallister, Raman Maksimchuk'
-release = '"Globality"'
-version = '24.1'
+release = '24.1 "Globality"' # OK displayed
+version = '24.1' # version is not displayed in either HTML pages or PDF docs
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/make.ps1

@@ -0,0 +1,26 @@
+# Command file for Sphinx documentation
+# PowerShell version without env var usage
+
+param (
+    [string]$command
+)
+
+# Define sphinx-build as a normal variable
+$sphinxBuild = "sphinx-build"
+
+$SOURCEDIR = "."
+$BUILDDIR = "_build"
+
+Write-Host "Doing $command ..."
+
+if ([string]::IsNullOrEmpty($command)) {
+    $status = "FAILED"
+    Write-Host "There is no build command! Available commands: clean, html"
+    Write-Host "See Sphinx Help below."
+    & $sphinxBuild -M help $SOURCEDIR $BUILDDIR $SPHINXOPTS $O
+} else {
+    & $sphinxBuild -M $command $SOURCEDIR $BUILDDIR $SPHINXOPTS $O
+    $status = "DONE"
+}
+
+Write-Host "Build $status"