Merge branch 'support/5.x' into main

arturcic · arturcic · commit da52067722c7 · 2022-04-02T12:45:52.000+02:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: peter-evans/repository-dispatch@v1.1.3
+      - uses: peter-evans/repository-dispatch@v2
         with:
           token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
           repository: ${{ github.repository }}
diff --git a/docs/input/docs/learn/who.md b/docs/input/docs/learn/who.md
@@ -12,6 +12,7 @@ that we know about today.
 *   [ChocolateyGUI](https://github.com/chocolatey/ChocolateyGUI)
 *   [GitLink](https://github.com/GitTools/GitLink)
 *   [OctopusDeploy](https://github.com/OctopusDeploy)
+*   [NUKE](https://nuke.build)
 *   [Orc.\* packages](https://github.com/wildgums?query=orc)
 *   [Orchestra](https://github.com/wildgums/orchestra)
 *   [Pomona](http://pomona.io/)
@@ -20,6 +21,7 @@ that we know about today.
 *   [Splat](https://github.com/paulcbetts/splat)
 *   [ReactiveUI](https://github.com/reactiveui/reactiveui)
 *   [Uno Platform](https://platform.uno/)
+*   [Fluent Assertions](https://fluentassertions.com)
 
 If you are using GitVersion in your projects, and you are not listed above,
 please feel free to add a link to your project.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -37,7 +37,7 @@
         <PackageVersion_MicrosoftTestSdk>17.1.0</PackageVersion_MicrosoftTestSdk>
         <PackageVersion_NSubstitute>4.3.0</PackageVersion_NSubstitute>
         <PackageVersion_CoverletMsBuild>3.1.2</PackageVersion_CoverletMsBuild>
-        <PackageVersion_NUnit>3.13.2</PackageVersion_NUnit>
+        <PackageVersion_NUnit>3.13.3</PackageVersion_NUnit>
         <PackageVersion_NUnit3TestAdapter>4.2.1</PackageVersion_NUnit3TestAdapter>
         <PackageVersion_NunitXmlTestLogger>3.0.117</PackageVersion_NunitXmlTestLogger>
         <PackageVersion_Shouldly>4.0.3</PackageVersion_Shouldly>
diff --git a/src/GitVersion.Core.Tests/BuildAgents/AzurePipelinesTests.cs b/src/GitVersion.Core.Tests/BuildAgents/AzurePipelinesTests.cs
@@ -80,4 +80,43 @@ public void AzurePipelinesBuildNumberWithSemVer(string buildNumberFormat, string
         var logMessage = this.buildServer.GenerateSetVersionMessage(vars);
         logMessage.ShouldBe(logPrefix + expectedBuildNumber);
     }
+
+    [Test]
+    public void GetCurrentBranchShouldHandleBranches()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("BUILD_SOURCEBRANCH", $"refs/heads/{MainBranch}");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBe($"refs/heads/{MainBranch}");
+    }
+
+    [Test]
+    public void GetCurrentBranchShouldHandleTags()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("BUILD_SOURCEBRANCH", "refs/tags/1.0.0");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
+
+    [Test]
+    public void GetCurrentBranchShouldHandlePullRequests()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("BUILD_SOURCEBRANCH", "refs/pull/1/merge");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
 }
diff --git a/src/GitVersion.Core.Tests/BuildAgents/BuildKiteTests.cs b/src/GitVersion.Core.Tests/BuildAgents/BuildKiteTests.cs
@@ -72,7 +72,7 @@ public void GetCurrentBranchShouldHandlePullRequests()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/pull/55/head");
+        result.ShouldBeNull();
     }
 
     [Test]
diff --git a/src/GitVersion.Core.Tests/BuildAgents/CodeBuildTests.cs b/src/GitVersion.Core.Tests/BuildAgents/CodeBuildTests.cs
@@ -102,4 +102,30 @@ private void AssertVariablesAreWrittenToFile(string file)
         props.ShouldContain("GitVersion_Major=1");
         props.ShouldContain("GitVersion_Minor=2");
     }
+
+    [Test]
+    public void GetCurrentBranchShouldHandleTags()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("CODEBUILD_WEBHOOK_HEAD_REF", "refs/tags/1.0.0");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
+
+    [Test]
+    public void GetCurrentBranchShouldHandlePullRequests()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("CODEBUILD_SOURCE_VERSION", "refs/pull/1/merge");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
 }
diff --git a/src/GitVersion.Core.Tests/BuildAgents/GitHubActionsTests.cs b/src/GitVersion.Core.Tests/BuildAgents/GitHubActionsTests.cs
@@ -83,7 +83,7 @@ public void GetCurrentBranchShouldHandleTags()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/tags/1.0.0");
+        result.ShouldBeNull();
     }
 
     [Test]
@@ -96,7 +96,7 @@ public void GetCurrentBranchShouldHandlePullRequests()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/pull/1/merge");
+        result.ShouldBeNull();
     }
 
     [Test]
diff --git a/src/GitVersion.Core.Tests/BuildAgents/SpaceAutomationTests.cs b/src/GitVersion.Core.Tests/BuildAgents/SpaceAutomationTests.cs
@@ -1,11 +1,10 @@
-using GitVersion;
 using GitVersion.BuildAgents;
 using GitVersion.Core.Tests.Helpers;
 using Microsoft.Extensions.DependencyInjection;
 using NUnit.Framework;
 using Shouldly;
 
-namespace GitVersionCore.Tests.BuildAgents;
+namespace GitVersion.Core.Tests.BuildAgents;
 
 [TestFixture]
 public class SpaceAutomationTests : TestBase
@@ -71,7 +70,7 @@ public void GetCurrentBranchShouldHandleTags()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/tags/1.0.0");
+        result.ShouldBeNull();
     }
 
     [Test]
@@ -84,7 +83,7 @@ public void GetCurrentBranchShouldHandlePullRequests()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/pull/1/merge");
+        result.ShouldBeNull();
     }
 
     [Test]
diff --git a/src/GitVersion.Core.Tests/Configuration/ConfigExtensionsTests.cs b/src/GitVersion.Core.Tests/Configuration/ConfigExtensionsTests.cs
@@ -0,0 +1,30 @@
+using GitVersion.Configuration;
+using GitVersion.Core.Tests.Helpers;
+using GitVersion.Model.Configuration;
+using NUnit.Framework;
+using Shouldly;
+
+namespace GitVersion.Core.Tests.Configuration;
+
+[TestFixture]
+public class ConfigExtensionsTests : TestBase
+{
+    [Test]
+    public void GetReleaseBranchConfigReturnsAllReleaseBranches()
+    {
+        var config = new Config()
+        {
+            Branches = new Dictionary<string, BranchConfig>
+            {
+                { "foo", new BranchConfig { Name = "foo" } },
+                { "bar", new BranchConfig { Name = "bar", IsReleaseBranch = true } },
+                { "baz", new BranchConfig { Name = "baz", IsReleaseBranch = true } }
+            }
+        };
+
+        var result = config.GetReleaseBranchConfig();
+
+        result.Count.ShouldBe(2);
+        result.ShouldNotContain(b => b.Key == "foo");
+    }
+}
diff --git a/src/GitVersion.Core/BuildAgents/AzurePipelines.cs b/src/GitVersion.Core/BuildAgents/AzurePipelines.cs
@@ -21,7 +21,17 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         $"##vso[task.setvariable variable=GitVersion.{name};isOutput=true]{value}"
     };
 
-    public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("BUILD_SOURCEBRANCH");
+    public override string? GetCurrentBranch(bool usingDynamicRepos)
+    {
+        // https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables
+        // BUILD_SOURCEBRANCH does not contain the branch name if the build was triggered by a tag or pull request.
+        string? branchName = Environment.GetEnvironmentVariable("BUILD_SOURCEBRANCH");
+        if (branchName != null && branchName.StartsWith("refs/heads/"))
+        {
+            return branchName;
+        }
+        return null;
+    }
 
     public override bool PreventFetch() => true;
 
diff --git a/src/GitVersion.Core/BuildAgents/BuildKite.cs b/src/GitVersion.Core/BuildAgents/BuildKite.cs
@@ -30,9 +30,9 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         }
         else
         {
-            // For pull requests BUILDKITE_BRANCH refers to the head, so adjust the
-            // branch name for pull request versioning to function as expected
-            return string.Format("refs/pull/{0}/head", pullRequest);
+            // To align the behavior with the other BuildAgent implementations
+            // we return here also null.
+            return null;
         }
     }
 
diff --git a/src/GitVersion.Core/BuildAgents/CodeBuild.cs b/src/GitVersion.Core/BuildAgents/CodeBuild.cs
@@ -25,9 +25,17 @@ public override string[] GenerateSetParameterMessage(string name, string value)
 
     public override string? GetCurrentBranch(bool usingDynamicRepos)
     {
-        var currentBranch = Environment.GetEnvironmentVariable(WebHookEnvironmentVariableName);
-
-        return currentBranch.IsNullOrEmpty() ? Environment.GetEnvironmentVariable(SourceVersionEnvironmentVariableName) : currentBranch;
+        string? branchName = Environment.GetEnvironmentVariable(WebHookEnvironmentVariableName);
+        if (string.IsNullOrEmpty(branchName))
+        {
+            branchName = Environment.GetEnvironmentVariable(SourceVersionEnvironmentVariableName);
+        }
+
+        if (branchName != null && branchName.StartsWith("refs/heads/"))
+        {
+            return branchName;
+        }
+        return null;
     }
 
     public override void WriteIntegration(Action<string?> writer, VersionVariables variables, bool updateBuildNumber = true)
diff --git a/src/GitVersion.Core/BuildAgents/GitHubActions.cs b/src/GitVersion.Core/BuildAgents/GitHubActions.cs
@@ -50,7 +50,18 @@ public override void WriteIntegration(Action<string?> writer, VersionVariables v
         }
     }
 
-    public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("GITHUB_REF");
+    public override string? GetCurrentBranch(bool usingDynamicRepos)
+    {
+        // https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+        // GITHUB_REF must be used only for "real" branches, not for tags and pull requests.
+        // Bug fix for https://github.com/GitTools/GitVersion/issues/2838
+        string? githubRef = Environment.GetEnvironmentVariable("GITHUB_REF");
+        if (githubRef != null && githubRef.StartsWith("refs/heads/"))
+        {
+            return githubRef;
+        }
+        return null;
+    }
 
     public override bool PreventFetch() => true;
 }
diff --git a/src/GitVersion.Core/BuildAgents/GitLabCi.cs b/src/GitVersion.Core/BuildAgents/GitLabCi.cs
@@ -22,7 +22,9 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         $"GitVersion_{name}={value}"
     };
 
-    public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("CI_COMMIT_REF_NAME");
+    // According to https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
+    // the CI_COMMIT_BRANCH environment variable must be used.
+    public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("CI_COMMIT_BRANCH");
 
     public override bool PreventFetch() => true;
 
diff --git a/src/GitVersion.Core/BuildAgents/SpaceAutomation.cs b/src/GitVersion.Core/BuildAgents/SpaceAutomation.cs
@@ -13,7 +13,15 @@ public SpaceAutomation(IEnvironment environment, ILog log) : base(environment, l
 
     protected override string EnvironmentVariable => EnvironmentVariableName;
 
-    public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("JB_SPACE_GIT_BRANCH");
+    public override string? GetCurrentBranch(bool usingDynamicRepos)
+    {
+        string? branchName = Environment.GetEnvironmentVariable("JB_SPACE_GIT_BRANCH");
+        if (branchName != null && branchName.StartsWith("refs/heads/"))
+        {
+            return branchName;
+        }
+        return null;
+    }
 
     public override string[] GenerateSetParameterMessage(string name, string value) => Array.Empty<string>();
 
diff --git a/src/GitVersion.Core/Configuration/ConfigExtensions.cs b/src/GitVersion.Core/Configuration/ConfigExtensions.cs
@@ -142,15 +142,8 @@ public static string GetBranchSpecificTag(this EffectiveConfiguration configurat
         return tagToUse;
     }
 
-    public static List<KeyValuePair<string, BranchConfig>> GetReleaseBranchConfig(this Config configuration)
-    {
-        foreach (var (key, value) in configuration.Branches)
-        {
-            if (value?.IsReleaseBranch != null && value.IsReleaseBranch.Value)
-            {
-                return new List<KeyValuePair<string, BranchConfig>> { new(key, value) };
-            }
-        }
-        return new List<KeyValuePair<string, BranchConfig>>();
-    }
+    public static List<KeyValuePair<string, BranchConfig>> GetReleaseBranchConfig(this Config configuration) =>
+        configuration.Branches
+            .Where(b => b.Value.IsReleaseBranch == true)
+            .ToList();
 }

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public void GetCurrentBranchShouldHandlePullRequests()`
`72`	`72`	`var result = this.buildServer.GetCurrentBranch(false);`
`73`	`73`
`74`	`74`	`// Assert`
`75`		`- result.ShouldBe("refs/pull/55/head");`
	`75`	`+ result.ShouldBeNull();`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`[Test]`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public void GetCurrentBranchShouldHandleTags()`
`83`	`83`	`var result = this.buildServer.GetCurrentBranch(false);`
`84`	`84`
`85`	`85`	`// Assert`
`86`		`- result.ShouldBe("refs/tags/1.0.0");`
	`86`	`+ result.ShouldBeNull();`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`[Test]`
`@@ -96,7 +96,7 @@ public void GetCurrentBranchShouldHandlePullRequests()`
`96`	`96`	`var result = this.buildServer.GetCurrentBranch(false);`
`97`	`97`
`98`	`98`	`// Assert`
`99`		`- result.ShouldBe("refs/pull/1/merge");`
	`99`	`+ result.ShouldBeNull();`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`[Test]`