Implement code review suggestions.

HHobeck · HHobeck · commit fc9d7f739cb5 · 2024-01-28T11:45:43.000+01:00
diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md
@@ -38,13 +38,12 @@
     *   ManualDeployment (previously ContinuousDelivery)
     *   ContinuousDelivery (previously ContinuousDeployment)
     *   ContinuousDeployment (new)
-*   On the configuration root level a new property with name `version-strategy` has been introduced with following values:
+*   At the configuration root level, a new array called `strategies` has been introduced, which can consist of on or more following values:
     *   ConfigNext
     *   MergeMessage
     *   TaggedCommit
     *   TrackReleaseBranches
     *   VersionInBranchName
-    *   NonTrunkBased = ConfigNext | MergeMessage | TaggedCommit | TrackReleaseBranches | VersionInBranchName,
     *   TrunkBased
 
 ## v5.0.0
diff --git a/docs/input/docs/reference/configuration.md b/docs/input/docs/reference/configuration.md
@@ -53,7 +53,8 @@ commit-date-format: yyyy-MM-dd
 merge-message-formats: {}
 update-build-number: true
 semantic-version-format: Strict
-version-strategy: NonTrunkBased
+strategies:
+- ConfigNext, MergeMessage, TaggedCommit, TrackReleaseBranches, VersionInBranchName
 branches:
   develop:
     mode: ContinuousDeployment
@@ -686,13 +687,12 @@ Example of invalid `Strict`, but valid `Loose`
 [variables]: /docs/reference/variables
 [version-sources]: /docs/reference/version-sources
 
-### version-strategy
+### strategies
 
 Specifies which version strategy implementation (one ore more) will be used to determine the next version. Following values are supported and can be combined:
 *   ConfigNext
 *   MergeMessage
 *   TaggedCommit
 *   TrackReleaseBranches
 *   VersionInBranchName
-*   NonTrunkBased = ConfigNext,MergeMessage,TaggedCommit,TrackReleaseBranches,VersionInBranchName
 *   TrunkBased
diff --git a/src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt b/src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt
@@ -11,7 +11,8 @@ commit-date-format: yyyy-MM-dd
 merge-message-formats: {}
 update-build-number: true
 semantic-version-format: Strict
-version-strategy: NonTrunkBased
+strategies:
+- ConfigNext, MergeMessage, TaggedCommit, TrackReleaseBranches, VersionInBranchName
 branches:
   develop:
     label: alpha
diff --git a/src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs b/src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs
@@ -60,7 +60,7 @@ public void OverwritesDefaultsWithProvidedConfig()
     public void CombineVersionStrategyConfigNextAndTaggedCommit()
     {
         // Arrange
-        SetupConfigFileContent("version-strategy: ConfigNext,TaggedCommit");
+        SetupConfigFileContent("strategies: [ConfigNext, TaggedCommit]");
 
         // Act
         var configuration = this.configurationProvider.ProvideForDirectory(this.repoPath);
diff --git a/src/GitVersion.Configuration.Tests/Configuration/Init/InitScenarios.CanSetNextVersion.approved.txt b/src/GitVersion.Configuration.Tests/Configuration/Init/InitScenarios.CanSetNextVersion.approved.txt
@@ -2,7 +2,8 @@ next-version: 2.0.0
 merge-message-formats: {}
 update-build-number: true
 semantic-version-format: Strict
-version-strategy: None
+strategies:
+- None
 branches: {}
 ignore:
   sha: []
diff --git a/src/GitVersion.Configuration/ConfigurationBuilderBase.cs b/src/GitVersion.Configuration/ConfigurationBuilderBase.cs
@@ -24,7 +24,7 @@ internal abstract class ConfigurationBuilderBase<TConfigurationBuilder> : IConfi
     private string? commitDateFormat;
     private bool updateBuildNumber;
     private SemanticVersionFormat semanticVersionFormat;
-    private VersionStrategies versionStrategy;
+    private VersionStrategies[] versionStrategies;
     private Dictionary<string, string> mergeMessageFormats = new();
     private readonly List<IReadOnlyDictionary<object, object?>> overrides = new();
     private readonly Dictionary<string, BranchConfigurationBuilder> branchConfigurationBuilders = new();
@@ -200,9 +200,9 @@ public virtual TConfigurationBuilder WithSemanticVersionFormat(SemanticVersionFo
         return (TConfigurationBuilder)this;
     }
 
-    public virtual TConfigurationBuilder WithVersionStrategy(VersionStrategies value)
+    public virtual TConfigurationBuilder WithVersionStrategies(params VersionStrategies[] values)
     {
-        this.versionStrategy = value;
+        this.versionStrategies = values;
         return (TConfigurationBuilder)this;
     }
 
@@ -328,7 +328,7 @@ public virtual TConfigurationBuilder WithConfiguration(IGitVersionConfiguration
         WithCommitDateFormat(value.CommitDateFormat);
         WithUpdateBuildNumber(value.UpdateBuildNumber);
         WithSemanticVersionFormat(value.SemanticVersionFormat);
-        WithVersionStrategy(value.VersionStrategy);
+        WithVersionStrategies(value.VersionStrategy);
         WithMergeMessageFormats(value.MergeMessageFormats);
         foreach (var (name, branchConfiguration) in value.Branches)
         {
@@ -385,7 +385,7 @@ public virtual IGitVersionConfiguration Build()
             CommitDateFormat = this.commitDateFormat,
             UpdateBuildNumber = this.updateBuildNumber,
             SemanticVersionFormat = this.semanticVersionFormat,
-            VersionStrategy = this.versionStrategy,
+            VersionStrategies = this.versionStrategies,
             Branches = branches,
             MergeMessageFormats = this.mergeMessageFormats,
             DeploymentMode = this.versioningMode,
diff --git a/src/GitVersion.Configuration/GitFlowConfigurationBuilder.cs b/src/GitVersion.Configuration/GitFlowConfigurationBuilder.cs
@@ -18,7 +18,7 @@ private GitFlowConfigurationBuilder()
             NoBumpMessage = IncrementStrategyFinder.DefaultNoBumpPattern,
             PatchVersionBumpMessage = IncrementStrategyFinder.DefaultPatchPattern,
             SemanticVersionFormat = ConfigurationConstants.DefaultSemanticVersionFormat,
-            VersionStrategy = ConfigurationConstants.DefaultVersionStrategy,
+            VersionStrategies = ConfigurationConstants.DefaultVersionStrategies,
             TagPrefix = ConfigurationConstants.DefaultTagPrefix,
             VersionInBranchPattern = ConfigurationConstants.DefaultVersionInBranchPattern,
             TagPreReleaseWeight = ConfigurationConstants.DefaultTagPreReleaseWeight,
diff --git a/src/GitVersion.Configuration/GitHubFlowConfigurationBuilder.cs b/src/GitVersion.Configuration/GitHubFlowConfigurationBuilder.cs
@@ -18,7 +18,7 @@ private GitHubFlowConfigurationBuilder()
             NoBumpMessage = IncrementStrategyFinder.DefaultNoBumpPattern,
             PatchVersionBumpMessage = IncrementStrategyFinder.DefaultPatchPattern,
             SemanticVersionFormat = ConfigurationConstants.DefaultSemanticVersionFormat,
-            VersionStrategy = ConfigurationConstants.DefaultVersionStrategy,
+            VersionStrategies = ConfigurationConstants.DefaultVersionStrategies,
             TagPrefix = ConfigurationConstants.DefaultTagPrefix,
             VersionInBranchPattern = ConfigurationConstants.DefaultVersionInBranchPattern,
             TagPreReleaseWeight = ConfigurationConstants.DefaultTagPreReleaseWeight,
diff --git a/src/GitVersion.Configuration/GitVersionConfiguration.cs b/src/GitVersion.Configuration/GitVersionConfiguration.cs
@@ -124,10 +124,14 @@ public string? NextVersion
     [JsonPropertyDefault(DefaultSemanticVersionFormat)]
     public SemanticVersionFormat SemanticVersionFormat { get; internal set; }
 
-    [JsonPropertyName("version-strategy")]
-    [JsonPropertyDescription($"Specifies which version strategy (one or more) will be used to determine the next version. Following values are available: 'ConfigNext', 'MergeMessage', 'TaggedCommit', 'TrackReleaseBranches', 'VersionInBranchName' and 'TrunkBased'.")]
-    [JsonPropertyDefault(DefaultVersionStrategy)]
-    public VersionStrategies VersionStrategy { get; internal set; }
+    [JsonPropertyName("strategies")]
+    [JsonPropertyDescription($"Specifies which version strategies (one or more) will be used to determine the next version. Following values are available: 'ConfigNext', 'MergeMessage', 'TaggedCommit', 'TrackReleaseBranches', 'VersionInBranchName' and 'TrunkBased'.")]
+    public VersionStrategies[] VersionStrategies { get; internal set; } = [];
+
+    [JsonIgnore]
+
+    VersionStrategies IGitVersionConfiguration.VersionStrategy => VersionStrategies.Length == 0
+        ? VersionCalculation.VersionStrategies.None : VersionStrategies.Aggregate((one, another) => one | another);
 
     [JsonIgnore]
     IReadOnlyDictionary<string, IBranchConfiguration> IGitVersionConfiguration.Branches
diff --git a/src/GitVersion.Configuration/SupportedWorkflows/GitFlow/v1.yml b/src/GitVersion.Configuration/SupportedWorkflows/GitFlow/v1.yml
@@ -10,7 +10,7 @@ commit-date-format: yyyy-MM-dd
 merge-message-formats: {}
 update-build-number: true
 semantic-version-format: Strict
-versioning-strategy: 'ConfigNext,MergeMessage,TaggedCommit,TrackReleaseBranches,VersionInBranchName'
+strategies: [ConfigNext, MergeMessage, TaggedCommit, TrackReleaseBranches, VersionInBranchName]
 branches:
   develop:
     mode: ContinuousDeployment
diff --git a/src/GitVersion.Configuration/SupportedWorkflows/GitHubFlow/v1.yml b/src/GitVersion.Configuration/SupportedWorkflows/GitHubFlow/v1.yml
@@ -10,7 +10,7 @@ commit-date-format: yyyy-MM-dd
 merge-message-formats: {}
 update-build-number: true
 semantic-version-format: Strict
-versioning-strategy: 'ConfigNext,MergeMessage,TaggedCommit,TrackReleaseBranches,VersionInBranchName'
+strategies: [ConfigNext, MergeMessage, TaggedCommit, TrackReleaseBranches, VersionInBranchName]
 branches:
   main:
     label: ''
diff --git a/src/GitVersion.Configuration/SupportedWorkflows/TrunkBased/v1.yml b/src/GitVersion.Configuration/SupportedWorkflows/TrunkBased/v1.yml
@@ -10,7 +10,7 @@ commit-date-format: yyyy-MM-dd
 merge-message-formats: {}
 update-build-number: true
 semantic-version-format: Strict
-versioning-strategy: TrunkBased
+strategies: [TrunkBased]
 branches:
   main:
     label: ''
diff --git a/src/GitVersion.Core.Tests/IntegrationTests/ComparingTheBehaviorOfDifferentVersioningModes.cs b/src/GitVersion.Core.Tests/IntegrationTests/ComparingTheBehaviorOfDifferentVersioningModes.cs
@@ -20,7 +20,7 @@ private static GitHubFlowConfigurationBuilder GetConfigurationBuilder() => GitHu
         );
 
     private static readonly IGitVersionConfiguration trunkBased = GetConfigurationBuilder()
-        .WithVersionStrategy(VersionStrategies.TrunkBased)
+        .WithVersionStrategies(VersionStrategies.TrunkBased)
         .WithBranch("main", _ => _.WithIsMainBranch(true).WithDeploymentMode(DeploymentMode.ContinuousDeployment))
         .WithBranch("feature", _ => _.WithIsMainBranch(false).WithDeploymentMode(DeploymentMode.ContinuousDelivery))
         .Build();
diff --git a/src/GitVersion.Core.Tests/IntegrationTests/TrunkBasedDevelopmentScenarios.cs b/src/GitVersion.Core.Tests/IntegrationTests/TrunkBasedDevelopmentScenarios.cs
@@ -8,7 +8,7 @@ namespace GitVersion.Core.Tests.IntegrationTests;
 public class TrunkBasedDevelopmentScenarios : TestBase
 {
     private static GitFlowConfigurationBuilder GetConfigurationBuilder() => GitFlowConfigurationBuilder.New
-        .WithVersionStrategy(VersionStrategies.TrunkBased)
+        .WithVersionStrategies(VersionStrategies.TrunkBased)
         .WithBranch("main", builder => builder
             .WithIsMainBranch(true).WithIncrement(IncrementStrategy.Patch)
             .WithDeploymentMode(DeploymentMode.ContinuousDeployment)
@@ -511,7 +511,7 @@ public void MergingFeatureBranchThatIncrementsMinorNumberIncrementsMinorVersionO
     public void VerifyIncrementConfigIsHonoured()
     {
         var minorIncrementConfig = GitFlowConfigurationBuilder.New
-            .WithVersionStrategy(VersionStrategies.TrunkBased)
+            .WithVersionStrategies(VersionStrategies.TrunkBased)
             .WithBranch("main", builder => builder
                 .WithDeploymentMode(DeploymentMode.ContinuousDeployment)
                 .WithIncrement(IncrementStrategy.None)
diff --git a/src/GitVersion.Core.Tests/IntegrationTests/VersionBumpingScenarios.cs b/src/GitVersion.Core.Tests/IntegrationTests/VersionBumpingScenarios.cs
@@ -86,7 +86,7 @@ public void CanUseConventionalCommitsToBumpVersion(string commitMessage, string
             .WithMinorVersionBumpMessage("^(feat)(\\([\\w\\s-]*\\))?:")
             // For future debugging of this regex: https://regex101.com/r/oFpqxA/2
             .WithPatchVersionBumpMessage("^(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\\([\\w\\s-]*\\))?:")
-            .WithVersionStrategy(VersionStrategies.TrunkBased)
+            .WithVersionStrategies(VersionStrategies.TrunkBased)
             .WithBranch("main", builder => builder.WithDeploymentMode(DeploymentMode.ContinuousDeployment))
             .Build();
 
diff --git a/src/GitVersion.Core/Configuration/ConfigurationConstants.cs b/src/GitVersion.Core/Configuration/ConfigurationConstants.cs
@@ -14,7 +14,13 @@ internal static class ConfigurationConstants
     public const AssemblyVersioningScheme DefaultAssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch;
     public const AssemblyFileVersioningScheme DefaultAssemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch;
     public const SemanticVersionFormat DefaultSemanticVersionFormat = SemanticVersionFormat.Strict;
-    public const VersionStrategies DefaultVersionStrategy = VersionStrategies.NonTrunkBased;
+    public static readonly VersionStrategies[] DefaultVersionStrategies = [
+        VersionStrategies.ConfigNext,
+        VersionStrategies.MergeMessage,
+        VersionStrategies.TaggedCommit,
+        VersionStrategies.TrackReleaseBranches,
+        VersionStrategies.VersionInBranchName
+    ];
     public const string DefaultAssemblyInformationalFormat = "{InformationalVersion}";
     public const string DefaultTagPrefix = "[vV]?";
     public const string DefaultVersionInBranchPattern = @"(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*";
diff --git a/src/GitVersion.Core/PublicAPI.Unshipped.txt b/src/GitVersion.Core/PublicAPI.Unshipped.txt
@@ -727,7 +727,6 @@ GitVersion.VersionCalculation.VersionStrategies
 GitVersion.VersionCalculation.VersionStrategies.ConfigNext = 1 -> GitVersion.VersionCalculation.VersionStrategies
 GitVersion.VersionCalculation.VersionStrategies.MergeMessage = 2 -> GitVersion.VersionCalculation.VersionStrategies
 GitVersion.VersionCalculation.VersionStrategies.None = 0 -> GitVersion.VersionCalculation.VersionStrategies
-GitVersion.VersionCalculation.VersionStrategies.NonTrunkBased = GitVersion.VersionCalculation.VersionStrategies.ConfigNext | GitVersion.VersionCalculation.VersionStrategies.MergeMessage | GitVersion.VersionCalculation.VersionStrategies.TaggedCommit | GitVersion.VersionCalculation.VersionStrategies.TrackReleaseBranches | GitVersion.VersionCalculation.VersionStrategies.VersionInBranchName -> GitVersion.VersionCalculation.VersionStrategies
 GitVersion.VersionCalculation.VersionStrategies.TaggedCommit = 4 -> GitVersion.VersionCalculation.VersionStrategies
 GitVersion.VersionCalculation.VersionStrategies.TrackReleaseBranches = 8 -> GitVersion.VersionCalculation.VersionStrategies
 GitVersion.VersionCalculation.VersionStrategies.TrunkBased = 32 -> GitVersion.VersionCalculation.VersionStrategies
diff --git a/src/GitVersion.Core/VersionCalculation/VersionStrategies.cs b/src/GitVersion.Core/VersionCalculation/VersionStrategies.cs
@@ -9,6 +9,5 @@ public enum VersionStrategies
     TaggedCommit = 4,
     TrackReleaseBranches = 8,
     VersionInBranchName = 16,
-    NonTrunkBased = ConfigNext | MergeMessage | TaggedCommit | TrackReleaseBranches | VersionInBranchName,
     TrunkBased = 32,
 }

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public void OverwritesDefaultsWithProvidedConfig()`
`60`	`60`	`public void CombineVersionStrategyConfigNextAndTaggedCommit()`
`61`	`61`	`{`
`62`	`62`	`// Arrange`
`63`		`- SetupConfigFileContent("version-strategy: ConfigNext,TaggedCommit");`
	`63`	`+ SetupConfigFileContent("strategies: [ConfigNext, TaggedCommit]");`
`64`	`64`
`65`	`65`	`// Act`
`66`	`66`	`var configuration = this.configurationProvider.ProvideForDirectory(this.repoPath);`