Insert option to considered the remote name when generating a semantic version on a remote branch.

Author: HHobeck

docs/input/docs/reference/configuration.md

@@ -40,6 +40,7 @@ created. Modify this to suit your needs.
 The global configuration looks like this:
 
 ```yaml
+remote-name-in-git: origin
 assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatch
 label-prefix: '[vV]?'
@@ -160,7 +161,7 @@ ignore:
   sha: []
 mode: ContinuousDelivery
 label: '{BranchName}'
-increment: Inherit
+increment: Patch
 prevent-increment-of-merged-branch-version: false
 track-merge-target: false
 track-merge-message: true
@@ -173,6 +174,12 @@ is-mainline: false
 
 The details of the available options are as follows:
 
+### remote-name-in-git
+
+The user can define the name of the remote (in moste cases it's `origin`) which
+will be considered when generating a semantic version on a remote branch. If the
+actual remote name doesn't match this pattern an error will be thrown.
+
 ### next-version
 
 Allows you to bump the next version explicitly. Useful for bumping `main` or a

src/GitVersion.Core.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt

@@ -1,3 +1,4 @@
+remote-name-in-git: origin
 assembly-versioning-scheme: MajorMinorPatch
 assembly-file-versioning-scheme: MajorMinorPatch
 label-prefix: '[vV]?'

src/GitVersion.Core.Tests/Helpers/TestEffectiveConfiguration.cs

@@ -7,6 +7,7 @@ namespace GitVersion.Core.Tests.Helpers;
 public class TestEffectiveConfiguration : EffectiveConfiguration
 {
     public TestEffectiveConfiguration(
+        string remoteNameInGit = GitVersionConfiguration.DefaultRemoteNameInGit,
         AssemblyVersioningScheme assemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch,
         AssemblyFileVersioningScheme assemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch,
         string? assemblyVersioningFormat = null,
@@ -31,7 +32,8 @@ public TestEffectiveConfiguration(
         bool isMainline = false,
         string commitDateFormat = "yyyy-MM-dd",
         bool updateBuildNumber = false) :
-        base(assemblyVersioningScheme,
+        base(remoteNameInGit,
+            assemblyVersioningScheme,
             assemblyFileVersioningScheme,
             assemblyInformationalFormat,
             assemblyVersioningFormat,

src/GitVersion.Core.Tests/IntegrationTests/VersionInCurrentBranchNameScenarios.cs

@@ -38,17 +38,26 @@ public void TakesVersionFromNameOfBranchThatIsReleaseByConfig()
         fixture.AssertFullSemver("2.0.0+1", configuration);
     }
 
-    [Test]
-    public void TakesVersionFromNameOfRemoteReleaseBranchInOrigin()
+    [TestCase("origin")]
+    [TestCase("upstream")]
+    public void TakesVersionFromNameOfRemoteReleaseBranchInOrigin(string remoteNameInGit)
     {
+        var configuration = GitFlowConfigurationBuilder.New
+            .WithRemoteNameInGit(remoteNameInGit)
+            .Build();
+
         using var fixture = new RemoteRepositoryFixture();
+        if (remoteNameInGit != "origin")
+        {
+            fixture.LocalRepositoryFixture.Repository.Network.Remotes.Rename("origin", remoteNameInGit);
+        }
         fixture.BranchTo("release/2.0.0");
         fixture.MakeACommit();
         Commands.Fetch((Repository)fixture.LocalRepositoryFixture.Repository, fixture.LocalRepositoryFixture.Repository.Network.Remotes.First().Name, Array.Empty<string>(), new FetchOptions(), null);
 
-        fixture.LocalRepositoryFixture.Checkout("origin/release/2.0.0");
+        fixture.LocalRepositoryFixture.Checkout($"{remoteNameInGit}/release/2.0.0");
 
-        fixture.LocalRepositoryFixture.AssertFullSemver("2.0.0-beta.1+1");
+        fixture.LocalRepositoryFixture.AssertFullSemver("2.0.0-beta.1+1", configuration);
     }
 
     [Test]
@@ -61,7 +70,8 @@ public void DoesNotTakeVersionFromNameOfRemoteReleaseBranchInCustomRemote()
         Commands.Fetch((Repository)fixture.LocalRepositoryFixture.Repository, fixture.LocalRepositoryFixture.Repository.Network.Remotes.First().Name, Array.Empty<string>(), new FetchOptions(), null);
 
         fixture.LocalRepositoryFixture.Checkout("upstream/release/2.0.0");
+        Action action = () => fixture.LocalRepositoryFixture.GetVersion();
 
-        fixture.LocalRepositoryFixture.AssertFullSemver("0.0.0-beta.1+6"); // This test fails with 2.0.0-beta.1+1
+        action.ShouldThrow<InvalidOperationException>();
     }
 }

src/GitVersion.Core/Configuration/ConfigurationBuilderBase.cs

@@ -6,6 +6,7 @@ namespace GitVersion.Configuration;
 internal abstract class ConfigurationBuilderBase<TConfigurationBuilder>
     where TConfigurationBuilder : ConfigurationBuilderBase<TConfigurationBuilder>
 {
+    private string? remoteNameInGit;
     private AssemblyVersioningScheme? assemblyVersioningScheme;
     private AssemblyFileVersioningScheme? assemblyFileVersioningScheme;
     private string? assemblyInformationalFormat;
@@ -97,6 +98,13 @@ protected ConfigurationBuilderBase()
         }
     }
 
+    public virtual TConfigurationBuilder WithRemoteNameInGit(string? value)
+    {
+        this.remoteNameInGit = value;
+        return (TConfigurationBuilder)this;
+    }
+
+
     public virtual TConfigurationBuilder WithAssemblyVersioningScheme(AssemblyVersioningScheme? value)
     {
         this.assemblyVersioningScheme = value;
@@ -324,6 +332,7 @@ public virtual TConfigurationBuilder WithPreReleaseWeight(int? value)
 
     public virtual TConfigurationBuilder WithConfiguration(GitVersionConfiguration value)
     {
+        WithRemoteNameInGit(value.RemoteNameInGit);
         WithAssemblyVersioningScheme(value.AssemblyVersioningScheme);
         WithAssemblyFileVersioningScheme(value.AssemblyFileVersioningScheme);
         WithAssemblyInformationalFormat(value.AssemblyInformationalFormat);
@@ -376,6 +385,7 @@ public virtual GitVersionConfiguration Build()
     {
         GitVersionConfiguration configuration = new()
         {
+            RemoteNameInGit = this.remoteNameInGit,
             AssemblyVersioningScheme = this.assemblyVersioningScheme,
             AssemblyFileVersioningScheme = this.assemblyFileVersioningScheme,
             AssemblyInformationalFormat = this.assemblyInformationalFormat,

src/GitVersion.Core/Configuration/EffectiveConfiguration.cs

@@ -37,6 +37,7 @@ public EffectiveConfiguration(GitVersionConfiguration configuration, BranchConfi
         if (!configuration.LabelPreReleaseWeight.HasValue)
             throw new Exception("Configuration value for 'LabelPreReleaseWeight' has no value. (this should not happen, please report an issue)");
 
+        RemoteNameInGit = configuration.RemoteNameInGit;
         AssemblyVersioningScheme = configuration.AssemblyVersioningScheme.Value;
         AssemblyFileVersioningScheme = configuration.AssemblyFileVersioningScheme.Value;
         AssemblyInformationalFormat = configuration.AssemblyInformationalFormat;
@@ -68,7 +69,8 @@ public EffectiveConfiguration(GitVersionConfiguration configuration, BranchConfi
         LabelPreReleaseWeight = configuration.LabelPreReleaseWeight.Value;
     }
 
-    protected EffectiveConfiguration(AssemblyVersioningScheme assemblyVersioningScheme,
+    protected EffectiveConfiguration(string remoteNameInGit,
+        AssemblyVersioningScheme assemblyVersioningScheme,
         AssemblyFileVersioningScheme assemblyFileVersioningScheme,
         string? assemblyInformationalFormat,
         string? assemblyVersioningFormat,
@@ -97,6 +99,7 @@ protected EffectiveConfiguration(AssemblyVersioningScheme assemblyVersioningSche
         int preReleaseWeight,
         int labelPreReleaseWeight)
     {
+        RemoteNameInGit = remoteNameInGit;
         AssemblyVersioningScheme = assemblyVersioningScheme;
         AssemblyFileVersioningScheme = assemblyFileVersioningScheme;
         AssemblyInformationalFormat = assemblyInformationalFormat;
@@ -127,6 +130,7 @@ protected EffectiveConfiguration(AssemblyVersioningScheme assemblyVersioningSche
         LabelPreReleaseWeight = labelPreReleaseWeight;
     }
 
+    public string? RemoteNameInGit { get; }
     public bool TracksReleaseBranches { get; }
     public bool IsReleaseBranch { get; }
     public bool IsMainline { get; }

src/GitVersion.Core/Configuration/GitFlowConfigurationBuilder.cs

@@ -11,6 +11,7 @@ private GitFlowConfigurationBuilder()
     {
         WithConfiguration(new()
         {
+            RemoteNameInGit = GitVersionConfiguration.DefaultRemoteNameInGit,
             AssemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch,
             AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch,
             CommitDateFormat = "yyyy-MM-dd",

src/GitVersion.Core/Configuration/GitHubFlowConfigurationBuilder.cs

@@ -11,6 +11,7 @@ private GitHubFlowConfigurationBuilder()
     {
         WithConfiguration(new()
         {
+            RemoteNameInGit = GitVersionConfiguration.DefaultRemoteNameInGit,
             AssemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch,
             AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch,
             CommitDateFormat = "yyyy-MM-dd",

src/GitVersion.Core/Configuration/GitVersionConfiguration.cs

@@ -1,7 +1,3 @@
-using System.Globalization;
-using GitVersion.Attributes;
-using GitVersion.Extensions;
-
 namespace GitVersion.Configuration;
 
 public class GitVersionConfiguration : BranchConfiguration

src/GitVersion.Core/Core/GitVersionContextFactory.cs

@@ -1,8 +1,3 @@
-using GitVersion.Common;
-using GitVersion.Configuration;
-using GitVersion.Extensions;
-using Microsoft.Extensions.Options;
-
 namespace GitVersion;
 
 public class GitVersionContextFactory : IGitVersionContextFactory
@@ -31,6 +26,17 @@ public GitVersionContext Create(GitVersionOptions gitVersionOptions)
             currentBranch = branchForCommit ?? currentBranch;
         }
 
+        if (currentBranch.IsRemote)
+        {
+            var remoteNameInGit = configuration.RemoteNameInGit;
+            if (string.IsNullOrEmpty(remoteNameInGit) || !currentBranch.Name.Friendly.StartsWith(remoteNameInGit))
+            {
+                throw new InvalidOperationException(
+                    $"The remote branch name '{currentBranch.Name.Friendly}' is not valid. Please use another branch or change the configuration."
+                );
+            }
+        }
+
         var currentCommitTaggedVersion = this.repositoryStore.GetCurrentCommitTaggedVersion(currentCommit, configuration.LabelPrefix, configuration.SemanticVersionFormat, handleDetachedBranch: currentBranch.IsDetachedHead);
         var numberOfUncommittedChanges = this.repositoryStore.GetNumberOfUncommittedChanges();