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

Author: HHobeck

BREAKING_CHANGES.md

@@ -46,6 +46,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.App.Tests/ArgumentParserTests.cs

@@ -407,129 +407,76 @@ private static IEnumerable<TestCaseData> OverrideConfigWithSingleOptionTestData(
     {
         yield return new TestCaseData(
             "assembly-versioning-scheme=MajorMinor",
-            new GitVersionConfiguration
-            {
-                AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinor
-            }
+            EmptyConfigurationBuilder.New.WithAssemblyVersioningScheme(AssemblyVersioningScheme.MajorMinor).Build()
         );
         yield return new TestCaseData(
             "assembly-file-versioning-scheme=\"MajorMinorPatch\"",
-            new GitVersionConfiguration
-            {
-                AssemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch
-            }
+            EmptyConfigurationBuilder.New.WithAssemblyFileVersioningScheme(AssemblyFileVersioningScheme.MajorMinor).Build()
+
         );
         yield return new TestCaseData(
             "assembly-informational-format=\"{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}\"",
-            new GitVersionConfiguration
-            {
-                AssemblyInformationalFormat = "{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}"
-            }
+            EmptyConfigurationBuilder.New.WithAssemblyInformationalFormat("{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}").Build()
         );
         yield return new TestCaseData(
             "assembly-versioning-format=\"{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}\"",
-            new GitVersionConfiguration
-            {
-                AssemblyVersioningFormat = "{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}"
-            }
+            EmptyConfigurationBuilder.New.WithAssemblyVersioningFormat("{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}").Build()
         );
         yield return new TestCaseData(
             "assembly-file-versioning-format=\"{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}\"",
-            new GitVersionConfiguration
-            {
-                AssemblyFileVersioningFormat = "{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}"
-            }
+            EmptyConfigurationBuilder.New.WithAssemblyFileVersioningFormat("{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}").Build()
         );
         yield return new TestCaseData(
             "mode=ContinuousDelivery",
-            new GitVersionConfiguration
-            {
-                DeploymentMode = DeploymentMode.ContinuousDelivery
-            }
+            EmptyConfigurationBuilder.New.WithDeploymentMode(DeploymentMode.ContinuousDelivery).Build()
         );
         yield return new TestCaseData(
             "tag-prefix=sample",
-            new GitVersionConfiguration
-            {
-                TagPrefix = "sample"
-            }
+            EmptyConfigurationBuilder.New.WithTagPrefix("sample").Build()
         );
         yield return new TestCaseData(
             "label=cd-label",
-            new GitVersionConfiguration
-            {
-                Label = "cd-label"
-            }
+            EmptyConfigurationBuilder.New.WithLabel("cd-label").Build()
         );
         yield return new TestCaseData(
             "next-version=1",
-            new GitVersionConfiguration
-            {
-                NextVersion = "1"
-            }
+            EmptyConfigurationBuilder.New.WithNextVersion("1").Build()
         );
         yield return new TestCaseData(
             "major-version-bump-message=\"This is major version bump message.\"",
-            new GitVersionConfiguration
-            {
-                MajorVersionBumpMessage = "This is major version bump message."
-            }
+            EmptyConfigurationBuilder.New.WithMajorVersionBumpMessage("This is major version bump message.").Build()
         );
         yield return new TestCaseData(
             "minor-version-bump-message=\"This is minor version bump message.\"",
-            new GitVersionConfiguration
-            {
-                MinorVersionBumpMessage = "This is minor version bump message."
-            }
+            EmptyConfigurationBuilder.New.WithMinorVersionBumpMessage("This is minor version bump message.").Build()
         );
         yield return new TestCaseData(
             "patch-version-bump-message=\"This is patch version bump message.\"",
-            new GitVersionConfiguration
-            {
-                PatchVersionBumpMessage = "This is patch version bump message."
-            }
+            EmptyConfigurationBuilder.New.WithPatchVersionBumpMessage("This is patch version bump message.").Build()
         );
         yield return new TestCaseData(
             "no-bump-message=\"This is no bump message.\"",
-            new GitVersionConfiguration
-            {
-                NoBumpMessage = "This is no bump message."
-            }
+            EmptyConfigurationBuilder.New.WithNoBumpMessage("This is no bump message.").Build()
         );
         yield return new TestCaseData(
             "tag-pre-release-weight=2",
-            new GitVersionConfiguration
-            {
-                TagPreReleaseWeight = 2
-            }
+            EmptyConfigurationBuilder.New.WithTagPreReleaseWeight(2).Build()
         );
         yield return new TestCaseData(
             "commit-message-incrementing=MergeMessageOnly",
-            new GitVersionConfiguration
-            {
-                CommitMessageIncrementing = CommitMessageIncrementMode.MergeMessageOnly
-            }
+            EmptyConfigurationBuilder.New.WithCommitMessageIncrementing(CommitMessageIncrementMode.MergeMessageOnly).Build()
         );
         yield return new TestCaseData(
             "increment=Minor",
-            new GitVersionConfiguration
-            {
-                Increment = IncrementStrategy.Minor
-            }
+            EmptyConfigurationBuilder.New.WithIncrement(IncrementStrategy.Minor).Build()
         );
         yield return new TestCaseData(
             "commit-date-format=\"MM/dd/yyyy h:mm tt\"",
-            new GitVersionConfiguration
-            {
-                CommitDateFormat = "MM/dd/yyyy h:mm tt"
-            }
+            EmptyConfigurationBuilder.New.WithCommitDateFormat("MM/dd/yyyy h:mm tt").Build()
         );
         yield return new TestCaseData(
             "update-build-number=true",
-            new GitVersionConfiguration
-            {
-                UpdateBuildNumber = true
-            }
+            EmptyConfigurationBuilder.New.WithUpdateBuildNumber(true).Build()
         );
     }
 
@@ -545,31 +492,23 @@ private static IEnumerable<TestCaseData> OverrideConfigWithMultipleOptionsTestDa
     {
         yield return new TestCaseData(
             "/overrideconfig tag-prefix=sample /overrideconfig assembly-versioning-scheme=MajorMinor",
-            new GitVersionConfiguration
-            {
-                TagPrefix = "sample",
-                AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinor
-            }
+            EmptyConfigurationBuilder.New.WithTagPrefix("sample")
+                .WithAssemblyVersioningScheme(AssemblyVersioningScheme.MajorMinor).Build()
         );
         yield return new TestCaseData(
             "/overrideconfig tag-prefix=sample /overrideconfig assembly-versioning-format=\"{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}\"",
-            new GitVersionConfiguration
-            {
-                TagPrefix = "sample",
-                AssemblyVersioningFormat = "{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}"
-            }
+            EmptyConfigurationBuilder.New.WithTagPrefix("sample")
+                .WithAssemblyVersioningFormat("{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}").Build()
         );
         yield return new TestCaseData(
             "/overrideconfig tag-prefix=sample /overrideconfig assembly-versioning-format=\"{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}\" /overrideconfig update-build-number=true /overrideconfig assembly-versioning-scheme=MajorMinorPatchTag /overrideconfig mode=ContinuousDelivery /overrideconfig tag-pre-release-weight=4",
-            new GitVersionConfiguration
-            {
-                TagPrefix = "sample",
-                AssemblyVersioningFormat = "{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}",
-                UpdateBuildNumber = true,
-                AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatchTag,
-                DeploymentMode = DeploymentMode.ContinuousDelivery,
-                TagPreReleaseWeight = 4
-            }
+            EmptyConfigurationBuilder.New.WithTagPrefix("sample")
+                .WithAssemblyVersioningFormat("{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}")
+                .WithUpdateBuildNumber(true)
+                .WithAssemblyVersioningScheme(AssemblyVersioningScheme.MajorMinorPatchTag)
+                .WithDeploymentMode(DeploymentMode.ContinuousDelivery)
+                .WithTagPreReleaseWeight(4)
+                .Build()
         );
     }
 

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