#2254 GitHub Actions: Cake build job

Author: raman-m

.github/workflows/develop.yml

@@ -6,6 +6,7 @@ on:
    branches: [ "develop" ]
 
 jobs:
+#1 Official required job to run utilizing GitHub Actions infrastructure
   build:
     runs-on: ubuntu-latest
     strategy:
@@ -33,3 +34,46 @@ jobs:
       run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }} ./test/Ocelot.IntegrationTests/Ocelot.IntegrationTests.csproj
     - name: Acceptance Tests
       run: dotnet test --no-restore --no-build --verbosity minimal --framework net${{ matrix.dotnet-version }} ./test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
+
+#2 The build job to run in Docker container utilizing images from https://hub.docker.com/u/ocelot2
+# The main runnung script is build.cake, a cake-script which is hard to support because of slow and outdated integrated libs
+  # docker-build:
+  #   runs-on: ubuntu-latest
+  #   container:
+  #     image: node:18
+  #     env:
+  #       NODE_ENV: development
+  #     ports:
+  #       - 80
+  #     volumes:
+  #       - my_docker_volume:/volume_mount
+  #     options: --cpus 1
+  #   container:
+  #     image: ghcr.io/owner/image
+  #     credentials:
+  #       username: ${{ github.actor }}
+  #       password: ${{ secrets.github_token }}
+  #     steps:
+  #     - name: Check for dockerenv file
+  #       run: (ls /.dockerenv && echo Found dockerenv) || (echo No dockerenv)
+  build-cake:
+    runs-on: ubuntu-latest
+    steps:
+      - name: .NET version 
+        run: dotnet --version
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup .NET 9
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 9.0.x
+      - name: .NET version 
+        run: dotnet --version
+      - name: Get branch name
+        run: echo "Branch name is ${{ github.ref_name }}"
+      - name: Cake build
+        uses: cake-build/cake-action@v3
+        with:
+          target: Build

build.cake

@@ -1,4 +1,4 @@
-#tool dotnet:?package=GitVersion.Tool&version=5.12.0 // 6.0.0-beta.7 supports .NET 8, 7, 6
+#tool dotnet:?package=GitVersion.Tool&version=6.2.0 // .NET 8-9
 #tool dotnet:?package=coveralls.net&version=4.0.1
 #tool nuget:?package=ReportGenerator&version=5.2.4
 #addin nuget:?package=Newtonsoft.Json&version=13.0.3
@@ -14,6 +14,7 @@ using System.Linq;
 using System.Text.RegularExpressions;
 
 const string Release = "Release"; // task name, target, and Release config name
+const string PullRequest = "PullRequest"; // task name, target, and PullRequest config name
 const string AllFrameworks = "net8.0;net9.0";
 const string LatestFramework = "net9.0";
 
@@ -50,7 +51,7 @@ var releaseNotes = new List<string>();
 // internal build variables - don't change these.
 string committedVersion = "0.0.0-dev";
 GitVersion versioning = null;
-bool IsTechnicalRelease = false;
+bool IsTechnicalRelease = true;
 
 var target = Argument("target", "Default");
 var slnFile = (target == Release) ? $"./Ocelot.{Release}.sln" : "./Ocelot.sln";
@@ -88,13 +89,14 @@ Task("Compile")
 	.IsDependentOn("Version")
 	.Does(() =>
 	{	
+		Information("Branch: " + GetBranchName());
 		Information("Build: " + compileConfig);
 		Information("Solution: " + slnFile);
 		var settings = new DotNetBuildSettings
 		{
 			Configuration = compileConfig,
 		};
-		if (target != Release)
+		if (target == PullRequest)
 		{
 			settings.Framework = LatestFramework; // build using .NET 9 SDK only
 		}
@@ -121,13 +123,20 @@ Task("Version")
 	.Does(() =>
 	{
 		versioning = GetNuGetVersionForCommit();
-		var nugetVersion = versioning.NuGetVersion;
-		Information("SemVer version number: " + nugetVersion);
-
-		if (IsRunningOnCircleCI())
+		Information("#########################");
+		Information("# SemVer Information");
+		Information("#========================");
+		Information($"# {nameof(versioning.NuGetVersion)}: {versioning.NuGetVersion}");
+		Information($"# {nameof(versioning.BranchName)}: {versioning.BranchName}");
+		Information($"# {nameof(versioning.MajorMinorPatch)}: {versioning.MajorMinorPatch}");
+		Information($"# {nameof(versioning.SemVer)}: {versioning.SemVer}");
+		Information($"# {nameof(versioning.InformationalVersion)}: {versioning.InformationalVersion}");
+		Information("#########################");
+
+		if (IsRunningInCICD())
 		{
 			Information("Persisting version number...");
-			PersistVersion(committedVersion, nugetVersion);
+			PersistVersion(committedVersion, versioning.SemVer);
 		}
 		else
 		{
@@ -139,7 +148,7 @@ Task("GitLogUniqContributors")
 	.Does(() =>
 	{
 		var command = "log --format=\"%aN|%aE\" ";
-		// command += IsRunningOnCircleCI() ? "| sort | uniq" :
+		// command += IsRunningInCICD() ? "| sort | uniq" :
 		// 	IsRunningInPowershell() ? "| Sort-Object -Unique" : "| sort | uniq";
 		List<string> output = GitHelper(command);
 		output.Sort();
@@ -164,7 +173,7 @@ Task("CreateReleaseNotes")
         Information($"Generating release notes at {releaseNotesFile}");
         var lastReleaseTags = GitHelper("describe --tags --abbrev=0 --exclude net*");
         var lastRelease = lastReleaseTags.First(t => !t.StartsWith("net")); // skip 'net*-vX.Y.Z' tag and take 'major.minor.build'
-        var releaseVersion = versioning.NuGetVersion;
+        var releaseVersion = versioning.SemVer;
 
         // Read main header from Git file, substitute version in header, and add content further...
         Information("{0}  New release tag is " + releaseVersion);
@@ -465,7 +474,7 @@ Task("RunUnitTests")
 				.Append("--verbosity:detailed")
 				.Append("--consoleLoggerParameters:ErrorsOnly")
 		};
-		if (target != Release)
+		if (target == PullRequest)
 		{
 			settings.Framework = LatestFramework; // .NET 9 SDK only
 		}
@@ -482,7 +491,7 @@ Task("RunUnitTests")
 
 		GenerateReport(coverageSummaryFile);
 
-		if (IsRunningOnCircleCI() && IsMainOrDevelop())
+		if (IsRunningInCICD() && IsMainOrDevelop())
 		{
 			var repoToken = EnvironmentVariable(coverallsRepoToken);
 			if (string.IsNullOrEmpty(repoToken))
@@ -512,9 +521,9 @@ Task("RunUnitTests")
 
 		Information("Sequence Coverage: " + sequenceCoverage);
 
-		if(double.Parse(sequenceCoverage) < minCodeCoverage)
+		if (double.Parse(sequenceCoverage) < minCodeCoverage)
 		{
-			var whereToCheck = !IsRunningOnCircleCI() ? coverallsRepo : artifactsForUnitTestsDir;
+			var whereToCheck = !IsRunningInCICD() ? coverallsRepo : artifactsForUnitTestsDir;
 			throw new Exception(string.Format("Code coverage fell below the threshold of {0}%. You can find the code coverage report at {1}", minCodeCoverage, whereToCheck));
 		};
 	});
@@ -530,7 +539,7 @@ Task("RunAcceptanceTests")
 				.Append("--no-restore")
 				.Append("--no-build")
 		};
-		if (target != Release)
+		if (target == PullRequest)
 		{
 			settings.Framework = LatestFramework; // .NET 9 SDK only
 		}
@@ -551,7 +560,7 @@ Task("RunIntegrationTests")
 				.Append("--no-restore")
 				.Append("--no-build")
 		};
-		if (target != Release)
+		if (target == PullRequest)
 		{
 			settings.Framework = LatestFramework; // .NET 9 SDK only
 		}
@@ -602,7 +611,7 @@ Task("PublishGitHubRelease")
 	.IsDependentOn("CreateArtifacts")
 	.Does(() => 
 	{
-		if (!IsRunningOnCircleCI()) return;
+		if (!IsRunningInCICD()) return;
 
 		dynamic release = CreateGitHubRelease();
 		var path = packagesDir.ToString() + @"/**/*";
@@ -619,9 +628,9 @@ Task("EnsureStableReleaseRequirements")
     {
 		Information("Check if stable release...");
 
-        if (!IsRunningOnCircleCI())
+        if (!IsRunningInCICD())
 		{
-           throw new Exception("Stable release should happen via circleci");
+           throw new Exception("Stable release should happen via CI/CD");
 		}
 
 		Information("Release is stable...");
@@ -636,7 +645,7 @@ Task("DownloadGitHubReleaseArtifacts")
 			System.Threading.Thread.Sleep(5000);
 			EnsureDirectoryExists(packagesDir);
 
-			var releaseUrl = "https://api.github.com/repos/ThreeMammals/ocelot/releases/tags/" + versioning.NuGetVersion;
+			var releaseUrl = "https://api.github.com/repos/ThreeMammals/ocelot/releases/tags/" + versioning.SemVer;
 			var releaseInfo = await GetResourceAsync(releaseUrl);
         	var assets_url = Newtonsoft.Json.Linq.JObject.Parse(releaseInfo)
 				.Value<string>("assets_url");
@@ -665,7 +674,7 @@ Task("PublishToNuget")
 			return;
 		}
 
-		if (IsRunningOnCircleCI())
+		if (IsRunningInCICD())
 		{
 			// stable releases
 			var nugetFeedStableKey = EnvironmentVariable("OCELOT_NUGET_API_KEY_3Mammals");
@@ -762,7 +771,7 @@ private void SetupGitHubClient(System.Net.Http.HttpClient client)
 
 private dynamic CreateGitHubRelease()
 {
-	var json = $"{{ \"tag_name\": \"{versioning.NuGetVersion}\", \"target_commitish\": \"main\", \"name\": \"{versioning.NuGetVersion}\", \"body\": \"{ReleaseNotesAsJson()}\", \"draft\": true, \"prerelease\": true, \"generate_release_notes\": false }}";
+	var json = $"{{ \"tag_name\": \"{versioning.SemVer}\", \"target_commitish\": \"main\", \"name\": \"{versioning.SemVer}\", \"body\": \"{ReleaseNotesAsJson()}\", \"draft\": true, \"prerelease\": true, \"generate_release_notes\": false }}";
 	var content = new System.Net.Http.StringContent(json, System.Text.Encoding.UTF8, "application/json");
 
 	using (var client = new System.Net.Http.HttpClient())
@@ -816,7 +825,7 @@ private void CompleteGitHubRelease(dynamic release)
 {
 	int releaseId = release.id;
 	string url = release.url.ToString();
-	var json = $"{{ \"tag_name\": \"{versioning.NuGetVersion}\", \"target_commitish\": \"main\", \"name\": \"{versioning.NuGetVersion}\", \"body\": \"{ReleaseNotesAsJson()}\", \"draft\": false, \"prerelease\": false }}";
+	var json = $"{{ \"tag_name\": \"{versioning.SemVer}\", \"target_commitish\": \"main\", \"name\": \"{versioning.SemVer}\", \"body\": \"{ReleaseNotesAsJson()}\", \"draft\": false, \"prerelease\": false }}";
 	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");
 
@@ -856,14 +865,34 @@ private async Task<string> GetResourceAsync(string url)
 	}
 }
 
+private bool IsRunningInCICD()
+	=> IsRunningOnCircleCI() || IsRunningInGitHubActions();
 private bool IsRunningOnCircleCI()
-{
-    return !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable("CIRCLECI"));
-}
+	=> !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable("CIRCLECI"));
+private bool IsRunningInGitHubActions()
+	=> Environment.GetEnvironmentVariable("GITHUB_ACTIONS") == "true";
 
 private bool IsMainOrDevelop()
 {
-	var env = Environment.GetEnvironmentVariable("CIRCLE_BRANCH").ToLower();
-
-    return env == "main" || env == "develop";
+	var br = GetBranchName().ToLower();
+    return br == "main" || br == "develop";
+}
+private string GetBranchName()
+{
+	if (IsRunningOnCircleCI())
+	{
+		return Environment.GetEnvironmentVariable("CIRCLE_BRANCH");
+	}
+	else if (IsRunningInGitHubActions())
+	{
+		return GetGitHubBranchName();
+	}
+    return versioning.BranchName;
+}
+private string GetGitHubBranchName()
+{
+	string githubRef = Environment.GetEnvironmentVariable("GITHUB_REF");
+    return (!string.IsNullOrEmpty(githubRef) && githubRef.StartsWith("refs/heads/"))
+        ? githubRef.Substring("refs/heads/".Length)
+        : "Unknown Branch";
 }