Merge pull request #3882 from HHobeck/feature/Replace-the-version-mode-Mainline-Part-III

Replace the version mode Mainline in 6.x (Part III)

Author: arturcic

BREAKING_CHANGES.md

@@ -33,7 +33,11 @@
     *   Default `RegularExpression` for feature branches is changed from `^features?[/-]` to `^features?[/-](?<BranchName>.+)` to support using `{BranchName}` out-of-the-box
     *   Default `RegularExpression` for unknown branches is changed from `.*` to `(?<BranchName>.*)` to support using `{BranchName}` out-of-the-box
 *   The branch related property `is-mainline` in the configuration system has been renamed to `is-main-branch`
-
+*   The versioning mode has been renamed to deployment mode and consists of following values:
+    *   ManualDeployment (previously ContinuousDelivery)
+    *   ContinuousDelivery (previously ContinuousDeployment)
+    *   ContinuousDeployment (new)
+	
 ## v5.0.0
 
 *   Version numbers in branches other than `release` branches are no longer

CONTRIBUTING.md

@@ -52,7 +52,7 @@ We can then customize the configuration by chaining methods of the builder. At t
 For example:
 ```csharp
 var configuration = configurationBuilder
-    .WithVersioningMode(VersioningMode.ContinuousDeployment)
+    .WithDeploymentMode(DeploymentMode.ContinuousDeployment)
     .WithNextVersion("1.0.0")
     .Build();
 ```

build/build/Tasks/Test/UnitTest.cs

@@ -48,7 +48,7 @@ public override void OnError(Exception exception, BuildContext context)
     public override void Finally(BuildContext context)
     {
         var testResultsFiles = context.GetFiles($"{Paths.TestOutput}/*.results.xml");
-        if (!context.IsAzurePipelineBuild || !testResultsFiles.Any()) return;
+        if (!context.IsAzurePipelineBuild || testResultsFiles.Count == 0) return;
 
         var data = new AzurePipelinesPublishTestResultsData
         {

build/common/Utilities/Extensions.cs

@@ -38,7 +38,7 @@ public static string GetTaskArguments(this Type task)
         }
 
         var attributes = task.GetCustomAttributes<TaskArgumentAttribute>().ToArray();
-        if (attributes.Any())
+        if (attributes.Length != 0)
         {
             var arguments = attributes.Select(attribute => $"[--{attribute.Name} ({string.Join(" | ", attribute.PossibleValues)})]");
             return string.Join(" ", arguments);

schemas/6.0/GitVersion.configuration.json

@@ -55,6 +55,9 @@
     "commit-message-incrementing": {
       "$ref": "#/$defs/nullableOfCommitMessageIncrementMode"
     },
+    "mode": {
+      "$ref": "#/$defs/nullableOfDeploymentMode"
+    },
     "ignore": {
       "description": "The header property for the ignore configuration.",
       "type": "object",
@@ -173,9 +176,6 @@
       "default": "(?<version>[vV]?\\d+(\\.\\d+)?(\\.\\d+)?).*",
       "type": "string"
     },
-    "mode": {
-      "$ref": "#/$defs/nullableOfVersioningMode"
-    },
     "workflow": {
       "description": "The base template of the configuration to use. Possible values are: 'GitFlow/v1' or 'GitHubFlow/v1'",
       "type": "string"
@@ -188,6 +188,9 @@
         "commit-message-incrementing": {
           "$ref": "#/$defs/nullableOfCommitMessageIncrementMode"
         },
+        "mode": {
+          "$ref": "#/$defs/nullableOfDeploymentMode"
+        },
         "increment": {
           "$ref": "#/$defs/incrementStrategy"
         },
@@ -226,9 +229,6 @@
         },
         "tracks-release-branches": {
           "$ref": "#/$defs/nullableOfBoolean5"
-        },
-        "mode": {
-          "$ref": "#/$defs/nullableOfVersioningMode"
         }
       }
     },
@@ -240,6 +240,15 @@
         "MergeMessageOnly"
       ]
     },
+    "nullableOfDeploymentMode": {
+      "description": "The deployment mode for this branch. Can be 'ManualDeployment', 'ContinuousDelivery', 'ContinuousDeployment'.",
+      "enum": [
+        "ManualDeployment",
+        "ContinuousDelivery",
+        "ContinuousDeployment",
+        "TrunkBased"
+      ]
+    },
     "incrementStrategy": {
       "description": "The increment strategy for this branch. Can be 'Inherit', 'Patch', 'Minor', 'Major', 'None'.",
       "enum": [
@@ -330,14 +339,6 @@
         "null"
       ]
     },
-    "nullableOfVersioningMode": {
-      "description": "The versioning mode for this branch. Can be 'ContinuousDelivery', 'ContinuousDeployment', 'Mainline'.",
-      "enum": [
-        "ContinuousDelivery",
-        "ContinuousDeployment",
-        "Mainline"
-      ]
-    },
     "string3": {
       "format": "date-time",
       "description": "Commits before this date will be ignored. Format: yyyy-MM-ddTHH:mm:ss.",
@@ -352,4 +353,4 @@
       }
     }
   }
-}
+}

src/GitVersion.App.Tests/ArgumentParserTests.cs

@@ -444,7 +444,7 @@ private static IEnumerable<TestCaseData> OverrideConfigWithSingleOptionTestData(
             "mode=ContinuousDelivery",
             new GitVersionConfiguration
             {
-                VersioningMode = VersioningMode.ContinuousDelivery
+                DeploymentMode = DeploymentMode.ContinuousDelivery
             }
         );
         yield return new TestCaseData(
@@ -567,7 +567,7 @@ private static IEnumerable<TestCaseData> OverrideConfigWithMultipleOptionsTestDa
                 AssemblyVersioningFormat = "{Major}.{Minor}.{Patch}.{env:CI_JOB_ID ?? 0}",
                 UpdateBuildNumber = true,
                 AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatchTag,
-                VersioningMode = VersioningMode.ContinuousDelivery,
+                DeploymentMode = DeploymentMode.ContinuousDelivery,
                 TagPreReleaseWeight = 4
             }
         );

src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs

@@ -51,8 +51,8 @@ public void OverwritesDefaultsWithProvidedConfig()
         var developConfiguration = configuration.Branches["develop"];
         developConfiguration.Increment.ShouldBe(IncrementStrategy.Major);
         developConfiguration.Increment.ShouldNotBe(defaultConfiguration.Branches["develop"].Increment);
-        developConfiguration.VersioningMode.ShouldBe(VersioningMode.ContinuousDelivery);
-        developConfiguration.VersioningMode.ShouldNotBe(defaultConfiguration.Branches["develop"].VersioningMode);
+        developConfiguration.DeploymentMode.ShouldBe(DeploymentMode.ContinuousDelivery);
+        developConfiguration.DeploymentMode.ShouldNotBe(defaultConfiguration.Branches["develop"].DeploymentMode);
         developConfiguration.Label.ShouldBe("dev");
     }
 

src/GitVersion.Configuration/BranchConfiguration.cs

@@ -7,8 +7,8 @@ namespace GitVersion.Configuration;
 internal record BranchConfiguration : IBranchConfiguration
 {
     [JsonPropertyName("mode")]
-    [JsonPropertyDescription("The versioning mode for this branch. Can be 'ContinuousDelivery', 'ContinuousDeployment', 'Mainline'.")]
-    public VersioningMode? VersioningMode { get; internal set; }
+    [JsonPropertyDescription("The deployment mode for this branch. Can be 'ManualDeployment', 'ContinuousDelivery', 'ContinuousDeployment'.")]
+    public DeploymentMode? DeploymentMode { get; internal set; }
 
     [JsonPropertyName("label")]
     [JsonPropertyDescription("The label to use for this branch. Use the value {BranchName} or similar as a placeholder to insert a named capture group from RegularExpression (fx. the branch name).")]
@@ -85,7 +85,7 @@ public virtual IBranchConfiguration Inherit(IBranchConfiguration configuration)
         return new BranchConfiguration(this)
         {
             Increment = Increment == IncrementStrategy.Inherit ? configuration.Increment : Increment,
-            VersioningMode = VersioningMode ?? configuration.VersioningMode,
+            DeploymentMode = DeploymentMode ?? configuration.DeploymentMode,
             Label = Label ?? configuration.Label,
             PreventIncrementOfMergedBranchVersion = PreventIncrementOfMergedBranchVersion
                 ?? configuration.PreventIncrementOfMergedBranchVersion,

src/GitVersion.Configuration/BranchConfigurationBuilder.cs

@@ -6,7 +6,7 @@ internal class BranchConfigurationBuilder
 {
     public static BranchConfigurationBuilder New => new();
 
-    private VersioningMode? versioningMode;
+    private DeploymentMode? deploymentMode;
     private string? label;
     private IncrementStrategy increment;
     private bool? preventIncrementOfMergedBranchVersion;
@@ -26,9 +26,9 @@ private BranchConfigurationBuilder()
     {
     }
 
-    public virtual BranchConfigurationBuilder WithVersioningMode(VersioningMode? value)
+    public virtual BranchConfigurationBuilder WithDeploymentMode(DeploymentMode? value)
     {
-        this.versioningMode = value;
+        this.deploymentMode = value;
         return this;
     }
 
@@ -130,7 +130,7 @@ public virtual BranchConfigurationBuilder WithPreReleaseWeight(int? value)
 
     public virtual BranchConfigurationBuilder WithConfiguration(IBranchConfiguration value)
     {
-        WithVersioningMode(value.VersioningMode);
+        WithDeploymentMode(value.DeploymentMode);
         WithLabel(value.Label);
         WithIncrement(value.Increment);
         WithPreventIncrementOfMergedBranchVersion(value.PreventIncrementOfMergedBranchVersion);
@@ -150,7 +150,7 @@ public virtual BranchConfigurationBuilder WithConfiguration(IBranchConfiguration
 
     public IBranchConfiguration Build() => new BranchConfiguration
     {
-        VersioningMode = versioningMode,
+        DeploymentMode = deploymentMode,
         Label = label,
         Increment = increment,
         RegularExpression = regularExpression,

src/GitVersion.Configuration/ConfigurationBuilderBase.cs

@@ -27,7 +27,7 @@ internal abstract class ConfigurationBuilderBase<TConfigurationBuilder> : IConfi
     private Dictionary<string, string> mergeMessageFormats = new();
     private readonly List<IReadOnlyDictionary<object, object?>> overrides = new();
     private readonly Dictionary<string, BranchConfigurationBuilder> branchConfigurationBuilders = new();
-    private VersioningMode? versioningMode;
+    private DeploymentMode? versioningMode;
     private string? label;
     private IncrementStrategy increment = IncrementStrategy.Inherit;
     private bool? preventIncrementOfMergedBranchVersion;
@@ -224,7 +224,7 @@ public virtual TConfigurationBuilder WithBranch(string value, Action<BranchConfi
         return (TConfigurationBuilder)this;
     }
 
-    public virtual TConfigurationBuilder WithVersioningMode(VersioningMode? value)
+    public virtual TConfigurationBuilder WithDeploymentMode(DeploymentMode? value)
     {
         this.versioningMode = value;
         return (TConfigurationBuilder)this;
@@ -326,7 +326,7 @@ public virtual TConfigurationBuilder WithConfiguration(IGitVersionConfiguration
         {
             WithBranch(name).WithConfiguration(branchConfiguration);
         }
-        WithVersioningMode(value.VersioningMode);
+        WithDeploymentMode(value.DeploymentMode);
         WithLabel(value.Label);
         WithIncrement(value.Increment);
         WithPreventIncrementOfMergedBranchVersion(value.PreventIncrementOfMergedBranchVersion);
@@ -379,7 +379,7 @@ public virtual IGitVersionConfiguration Build()
             SemanticVersionFormat = this.semanticVersionFormat,
             Branches = branches,
             MergeMessageFormats = this.mergeMessageFormats,
-            VersioningMode = this.versioningMode,
+            DeploymentMode = this.versioningMode,
             Label = this.label,
             Increment = this.increment,
             RegularExpression = this.regularExpression,