Rename prevent-increment-when-tagged to prevent-increment-when-current-commit-tagged and update documentation.

Author: HHobeck

BREAKING_CHANGES.md

@@ -53,6 +53,7 @@
     *   VersionInBranchName
     *   TrunkBased
 *   The initialization wizard has been removed.
+*   On the `develop`, `release` and `hotfix` branch the introduced branch related property `prevent-increment-when-current-commit-tagged` has been set to `false` to get the incremented instead of the tagged semantic version.
 
 ## v5.0.0
 

docs/input/docs/reference/configuration.md

@@ -805,9 +805,9 @@ In a GitFlow-based repository, setting this option can have implications on the
 better version source proposed by the `MergeMessageBaseVersionStrategy`. For
 more details and an in-depth analysis, please see [the discussion][2506].
 
-### prevent-increment-when-tagged
+### prevent-increment-when-current-commit-tagged
 
-This branch related property can be used to control the behavior whether to take the incremented or the current tagged version.
+This branch related property controls the behvior whether to use the tagged (value set to true) or the incremented (value set to false) semantic version. Defaults to true.
 
 ### label-number-pattern
 

src/GitVersion.BuildAgents.Tests/Agents/BitBucketPipelinesTests.cs

@@ -147,7 +147,7 @@ private void AssertVariablesAreWrittenToFile(string propertyFile, string ps1File
 
         var variableProvider = this.sp.GetRequiredService<IVariableProvider>();
 
-        var variables = variableProvider.GetVariablesFor(semanticVersion, new GitVersionConfiguration(), 0);
+        var variables = variableProvider.GetVariablesFor(semanticVersion, EmptyConfigurationBuilder.New.Build(), 0);
 
         this.buildServer.WithPropertyFile(propertyFile);
         this.buildServer.WithPowershellFile(ps1File);

src/GitVersion.BuildAgents.Tests/Agents/BuildServerBaseTests.cs

@@ -37,7 +37,7 @@ public void BuildNumberIsFullSemVer()
             }
         };
 
-        var variables = this.buildServer.GetVariablesFor(semanticVersion, new GitVersionConfiguration(), 0);
+        var variables = this.buildServer.GetVariablesFor(semanticVersion, EmptyConfigurationBuilder.New.Build(), 0);
         var buildAgent = this.sp.GetRequiredService<BuildAgent>();
         buildAgent.WriteIntegration(writes.Add, variables);
 

src/GitVersion.BuildAgents.Tests/Agents/CodeBuildTests.cs

@@ -84,7 +84,7 @@ private void AssertVariablesAreWrittenToFile(string file)
 
         var variableProvider = this.sp.GetRequiredService<IVariableProvider>();
 
-        var variables = variableProvider.GetVariablesFor(semanticVersion, new GitVersionConfiguration(), 0);
+        var variables = variableProvider.GetVariablesFor(semanticVersion, EmptyConfigurationBuilder.New.Build(), 0);
 
         this.buildServer.WithPropertyFile(file);
 

src/GitVersion.BuildAgents.Tests/Agents/GitLabCiTests.cs

@@ -69,7 +69,7 @@ private void AssertVariablesAreWrittenToFile(string file)
 
         var variableProvider = this.sp.GetRequiredService<IVariableProvider>();
 
-        var variables = variableProvider.GetVariablesFor(semanticVersion, new GitVersionConfiguration(), 0);
+        var variables = variableProvider.GetVariablesFor(semanticVersion, EmptyConfigurationBuilder.New.Build(), 0);
 
         this.buildServer.WithPropertyFile(file);
 

src/GitVersion.BuildAgents.Tests/Agents/JenkinsTests.cs

@@ -136,7 +136,7 @@ private void AssertVariablesAreWrittenToFile(string file)
 
         var variableProvider = this.sp.GetRequiredService<IVariableProvider>();
 
-        var variables = variableProvider.GetVariablesFor(semanticVersion, new GitVersionConfiguration(), 0);
+        var variables = variableProvider.GetVariablesFor(semanticVersion, EmptyConfigurationBuilder.New.Build(), 0);
 
         this.buildServer.WithPropertyFile(file);
 

src/GitVersion.Configuration.Tests/Configuration/ConfigurationExtensionsTests.cs

@@ -9,15 +9,11 @@ public class ConfigurationExtensionsTests : TestBase
     [Test]
     public void GetReleaseBranchConfigReturnsAllReleaseBranches()
     {
-        var configuration = new GitVersionConfiguration
-        {
-            Branches = new Dictionary<string, BranchConfiguration>
-            {
-                { "foo", new BranchConfiguration() },
-                { "bar", new BranchConfiguration { IsReleaseBranch = true } },
-                { "baz", new BranchConfiguration { IsReleaseBranch = true } }
-            }
-        };
+        var configuration = EmptyConfigurationBuilder.New
+            .WithBranch("foo", _ => _.WithRegularExpression("foo"))
+            .WithBranch("bar", _ => _.WithRegularExpression("bar").WithIsReleaseBranch(true))
+            .WithBranch("baz", _ => _.WithRegularExpression("baz").WithIsReleaseBranch(true))
+            .Build();
 
         var result = configuration.GetReleaseBranchConfiguration();
 

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

@@ -22,7 +22,7 @@ branches:
     label: alpha
     increment: Minor
     prevent-increment-of-merged-branch-version: false
-    prevent-increment-when-tagged: false
+    prevent-increment-when-current-commit-tagged: false
     track-merge-target: true
     regex: ^dev(elop)?(ment)?$
     source-branches: []
@@ -50,7 +50,7 @@ branches:
     label: beta
     increment: None
     prevent-increment-of-merged-branch-version: true
-    prevent-increment-when-tagged: false
+    prevent-increment-when-current-commit-tagged: false
     track-merge-target: false
     regex: ^releases?[/-]
     source-branches:
@@ -96,7 +96,7 @@ branches:
     mode: ManualDeployment
     label: beta
     increment: Inherit
-    prevent-increment-when-tagged: false
+    prevent-increment-when-current-commit-tagged: false
     regex: ^hotfix(es)?[/-]
     source-branches:
     - release
@@ -139,7 +139,7 @@ mode: ContinuousDelivery
 label: '{BranchName}'
 increment: Inherit
 prevent-increment-of-merged-branch-version: false
-prevent-increment-when-tagged: true
+prevent-increment-when-current-commit-tagged: true
 track-merge-target: false
 track-merge-message: true
 commit-message-incrementing: Enabled

src/GitVersion.Configuration/BranchConfiguration.cs

@@ -22,9 +22,9 @@ internal record BranchConfiguration : IBranchConfiguration
     [JsonPropertyDescription("Prevent increment of merged branch version.")]
     public bool? PreventIncrementOfMergedBranchVersion { get; internal set; }
 
-    [JsonPropertyName("prevent-increment-when-tagged")] // take-incremented-version
-    [JsonPropertyDescription("Option to control which version should be taken for this branch. Can be.")]
-    public bool? PreventIncrementWhenTagged { get; internal set; }
+    [JsonPropertyName("prevent-increment-when-current-commit-tagged")]
+    [JsonPropertyDescription("This branch related property controls the behvior whether to use the tagged (value set to true) or the incremented (value set to false) semantic version. Defaults to true.")]
+    public bool? PreventIncrementWhenCurrentCommitTagged { get; internal set; }
 
     [JsonPropertyName("label-number-pattern")]
     [JsonPropertyDescription($"The regular expression pattern to use to extract the number from the branch name. Defaults to '{ConfigurationConstants.DefaultLabelNumberPattern}'.")]
@@ -93,7 +93,8 @@ public virtual IBranchConfiguration Inherit(IBranchConfiguration configuration)
             Label = Label ?? configuration.Label,
             PreventIncrementOfMergedBranchVersion = PreventIncrementOfMergedBranchVersion
                 ?? configuration.PreventIncrementOfMergedBranchVersion,
-            PreventIncrementWhenTagged = PreventIncrementWhenTagged ?? configuration.PreventIncrementWhenTagged,
+            PreventIncrementWhenCurrentCommitTagged = PreventIncrementWhenCurrentCommitTagged
+            ?? configuration.PreventIncrementWhenCurrentCommitTagged,
             LabelNumberPattern = LabelNumberPattern ?? configuration.LabelNumberPattern,
             TrackMergeTarget = TrackMergeTarget ?? configuration.TrackMergeTarget,
             TrackMergeMessage = TrackMergeMessage ?? configuration.TrackMergeMessage,