Change usage of BranchConfiguration to IBranchConfiguration where possible. Execute: dotnet run --project .\src\GitVersion.Schema --framework net7.0 -- --outputdirectory schemas --version 6.0

Author: HHobeck

schemas/6.0/GitVersion.configuration.json

@@ -84,7 +84,7 @@
       "$ref": "#/$defs/string1"
     },
     "label-prefix": {
-      "description": "A regex which is used to trim Git tags before processing. Defaults to [vV]?",
+      "description": "A regular expression which is used to trim Git tags before processing. Defaults to [vV]?",
       "type": "string"
     },
     "label-pre-release-weight": {
@@ -97,7 +97,7 @@
     "major-version-bump-message": {
       "format": "regex",
       "pattern": "\u0027\\\u002Bsemver:\\s?(breaking|major)\u0027",
-      "description": "The regex to match commit messages with to perform a major version increment. Default set to \u0027\\\u002Bsemver:\\s?(breaking|major)\u0027",
+      "description": "The regular expression to match commit messages with to perform a major version increment. Default set to \u0027\\\u002Bsemver:\\s?(breaking|major)\u0027",
       "type": "string"
     },
     "merge-message-formats": {
@@ -110,7 +110,7 @@
     "minor-version-bump-message": {
       "format": "regex",
       "pattern": "\u0027\\\u002Bsemver:\\s?(feature|minor)\u0027",
-      "description": "The regex to match commit messages with to perform a minor version increment. Default set to \u0027\\\u002Bsemver:\\s?(feature|minor)\u0027",
+      "description": "The regular expression to match commit messages with to perform a minor version increment. Default set to \u0027\\\u002Bsemver:\\s?(feature|minor)\u0027",
       "type": "string"
     },
     "next-version": {
@@ -126,7 +126,7 @@
     "patch-version-bump-message": {
       "format": "regex",
       "pattern": "\u0027\\\u002Bsemver:\\s?(fix|patch)\u0027",
-      "description": "The regex to match commit messages with to perform a patch version increment. Default set to \u0027\\\u002Bsemver:\\s?(fix|patch)\u0027",
+      "description": "The regular expression to match commit messages with to perform a patch version increment. Default set to \u0027\\\u002Bsemver:\\s?(fix|patch)\u0027",
       "type": "string"
     },
     "pre-release-weight": {
@@ -246,7 +246,7 @@
       ]
     },
     "Nullable\u006012": {
-      "description": "Indicates this branch config represents a release branch in GitFlow.",
+      "description": "Indicates this branch configuration represents a release branch in GitFlow.",
       "type": [
         "boolean",
         "null"
@@ -267,7 +267,7 @@
     "string1": {
       "format": "regex",
       "pattern": "[/-](?\u003Cnumber\u003E\\d\u002B)[-/]",
-      "description": "The regex pattern to use to extract the number from the branch name. Defaults to \u0027[/-](?\u003Cnumber\u003E\\d\u002B)[-/]\u0027.",
+      "description": "The regular expression pattern to use to extract the number from the branch name. Defaults to \u0027[/-](?\u003Cnumber\u003E\\d\u002B)[-/]\u0027.",
       "type": "string"
     },
     "Nullable\u006013": {
@@ -285,7 +285,7 @@
       ]
     },
     "string2": {
-      "description": "The regex pattern to use to match this branch.",
+      "description": "The regular expression pattern to use to match this branch.",
       "type": "string"
     },
     "array1": {
@@ -311,7 +311,7 @@
       ]
     },
     "Nullable\u006017": {
-      "description": "Indicates this branch config represents develop in GitFlow.",
+      "description": "Indicates this branch configuration represents develop in GitFlow.",
       "type": [
         "boolean",
         "null"

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

@@ -124,7 +124,7 @@ public void CanProvideConfigForNewBranch()
         SetupConfigFileContent(text);
         var configuration = this.configurationProvider.ProvideForDirectory(this.repoPath);
 
-        configuration.Branches["bug"].Regex.ShouldBe("bug[/-]");
+        configuration.Branches["bug"].RegularExpression.ShouldBe("bug[/-]");
         configuration.Branches["bug"].Label.ShouldBe("bugfix");
     }
 

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

@@ -396,7 +396,7 @@ public void WhenPreventIncrementOfMergedBranchVersionIsSetToFalseForDevelopCommi
             )
             .WithBranch("hotfix", builder => builder
                 .WithPreventIncrementOfMergedBranchVersion(true)
-                .WithRegex("^(origin/)?hotfix[/-]")
+                .WithRegularExpression("^(origin/)?hotfix[/-]")
             )
             .Build();
 

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

@@ -40,7 +40,7 @@ public void BranchCreatedAfterFastForwardMergeShouldInheritCorrectly()
         var configuration = GitFlowConfigurationBuilder.New
             .WithBranch("unstable", builder => builder
                 .WithIncrement(IncrementStrategy.Minor)
-                .WithRegex("unstable")
+                .WithRegularExpression("unstable")
                 .WithSourceBranches()
                 .WithIsSourceBranchFor("feature"))
             .Build();

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

@@ -68,7 +68,7 @@ public void LabelIsBranchNameForBranchesWithoutPrefixedBranchName(string label,
         var configuration = GitFlowConfigurationBuilder.New
             .WithBranch("other", builder => builder
                 .WithIncrement(IncrementStrategy.Patch)
-                .WithRegex(".*")
+                .WithRegularExpression(".*")
                 .WithSourceBranches()
                 .WithLabel(label))
             .Build();

src/GitVersion.Core.Tests/VersionCalculation/EffectiveBranchConfigurationFinderTests.cs

@@ -172,14 +172,14 @@ public void UsesFirstBranchConfigWhenMultipleMatch(string branchName, IncrementS
                 .WithVersioningMode(VersioningMode.ContinuousDeployment)
                 .WithIncrement(IncrementStrategy.None)
                 .WithLabel("latest")
-                .WithRegex("release/latest")
+                .WithRegularExpression("release/latest")
             )
             .WithBranch("release", builder => builder
                 .WithConfiguration(branchConfiguration)
                 .WithVersioningMode(VersioningMode.ContinuousDeployment)
                 .WithIncrement(IncrementStrategy.Patch)
                 .WithLabel("not-latest")
-                .WithRegex("releases?[/-]")
+                .WithRegularExpression("releases?[/-]")
             )
             .Build();
 

src/GitVersion.Core.Tests/VersionCalculation/NextVersionCalculatorTests.cs

@@ -70,7 +70,7 @@ public void PreReleaseLabelCanUseBranchName()
         var configuration = GitFlowConfigurationBuilder.New
             .WithNextVersion("1.0.0")
             .WithBranch("custom", builder => builder
-                .WithRegex("custom/")
+                .WithRegularExpression("custom/")
                 .WithLabel(ConfigurationConstants.BranchNamePlaceholder)
                 .WithSourceBranches()
             )
@@ -212,7 +212,7 @@ public void PreReleaseLabelCanUseBranchNameVariable()
         var configuration = GitFlowConfigurationBuilder.New
             .WithNextVersion("1.0.0")
             .WithBranch("custom", builder => builder
-                .WithRegex("custom/")
+                .WithRegularExpression("custom/")
                 .WithLabel($"alpha.{ConfigurationConstants.BranchNamePlaceholder}")
                 .WithSourceBranches()
             )

src/GitVersion.Core/Configuration/BranchConfiguration.cs

@@ -41,10 +41,10 @@ public record BranchConfiguration : IBranchConfiguration
 
     [JsonPropertyName("regex")]
     [JsonPropertyDescription("The regular expression pattern to use to match this branch.")]
-    public string? Regex { get; internal set; }
+    public string? RegularExpression { get; internal set; }
 
     [JsonIgnore]
-    string? IBranchConfiguration.RegularExpression => Regex;
+    string? IBranchConfiguration.RegularExpression => RegularExpression;
 
     [JsonPropertyName("source-branches")]
     [JsonPropertyDescription("The source branches for this branch.")]
@@ -76,7 +76,7 @@ public record BranchConfiguration : IBranchConfiguration
     [JsonPropertyDescription("Provides a way to translate the PreReleaseLabel to a number.")]
     public int? PreReleaseWeight { get; internal set; }
 
-    public virtual BranchConfiguration Inherit(BranchConfiguration configuration)
+    public virtual IBranchConfiguration Inherit(IBranchConfiguration configuration)
     {
         configuration.NotNull();
 
@@ -91,7 +91,7 @@ public virtual BranchConfiguration Inherit(BranchConfiguration configuration)
             TrackMergeTarget = TrackMergeTarget ?? configuration.TrackMergeTarget,
             TrackMergeMessage = TrackMergeMessage ?? configuration.TrackMergeMessage,
             CommitMessageIncrementing = CommitMessageIncrementing ?? configuration.CommitMessageIncrementing,
-            Regex = Regex ?? configuration.Regex,
+            RegularExpression = RegularExpression ?? configuration.RegularExpression,
             TracksReleaseBranches = TracksReleaseBranches ?? configuration.TracksReleaseBranches,
             IsReleaseBranch = IsReleaseBranch ?? configuration.IsReleaseBranch,
             IsMainline = IsMainline ?? configuration.IsMainline,

src/GitVersion.Core/Configuration/BranchConfigurationBuilder.cs

@@ -14,7 +14,7 @@ public class BranchConfigurationBuilder
     private bool? trackMergeTarget;
     private bool? trackMergeMessage;
     private CommitMessageIncrementMode? commitMessageIncrementing;
-    private string? regex;
+    private string? regularExpression;
     private HashSet<string> sourceBranches = new();
     private HashSet<string> isSourceBranchFor = new();
     private bool? tracksReleaseBranches;
@@ -74,9 +74,9 @@ public virtual BranchConfigurationBuilder WithCommitMessageIncrementing(CommitMe
         return this;
     }
 
-    public virtual BranchConfigurationBuilder WithRegex(string? value)
+    public virtual BranchConfigurationBuilder WithRegularExpression(string? value)
     {
-        this.regex = value;
+        this.regularExpression = value;
         return this;
     }
 
@@ -128,7 +128,7 @@ public virtual BranchConfigurationBuilder WithPreReleaseWeight(int? value)
         return this;
     }
 
-    public virtual BranchConfigurationBuilder WithConfiguration(BranchConfiguration value)
+    public virtual BranchConfigurationBuilder WithConfiguration(IBranchConfiguration value)
     {
         WithVersioningMode(value.VersioningMode);
         WithLabel(value.Label);
@@ -138,7 +138,7 @@ public virtual BranchConfigurationBuilder WithConfiguration(BranchConfiguration
         WithTrackMergeTarget(value.TrackMergeTarget);
         WithTrackMergeMessage(value.TrackMergeMessage);
         WithCommitMessageIncrementing(value.CommitMessageIncrementing);
-        WithRegex(value.Regex);
+        WithRegularExpression(value.RegularExpression);
         WithTracksReleaseBranches(value.TracksReleaseBranches);
         WithIsReleaseBranch(value.IsReleaseBranch);
         WithIsMainline(value.IsMainline);
@@ -153,7 +153,7 @@ public virtual BranchConfigurationBuilder WithConfiguration(BranchConfiguration
         VersioningMode = versioningMode,
         Label = label,
         Increment = increment,
-        Regex = regex,
+        RegularExpression = regularExpression,
         TracksReleaseBranches = tracksReleaseBranches,
         TrackMergeTarget = trackMergeTarget,
         TrackMergeMessage = trackMergeMessage,

src/GitVersion.Core/Configuration/ConfigurationBuilderBase.cs

@@ -33,7 +33,7 @@ internal abstract class ConfigurationBuilderBase<TConfigurationBuilder> : IConfi
     private bool? trackMergeTarget;
     private bool? trackMergeMessage;
     private CommitMessageIncrementMode? commitMessageIncrementing;
-    private string? regex;
+    private string? regularExpression;
     private bool? tracksReleaseBranches;
     private bool? isReleaseBranch;
     private bool? isMainline;
@@ -261,9 +261,9 @@ public virtual TConfigurationBuilder WithCommitMessageIncrementing(CommitMessage
         return (TConfigurationBuilder)this;
     }
 
-    public virtual TConfigurationBuilder WithRegex(string? value)
+    public virtual TConfigurationBuilder WithRegularExpression(string? value)
     {
-        this.regex = value;
+        this.regularExpression = value;
         return (TConfigurationBuilder)this;
     }
 
@@ -322,7 +322,7 @@ public virtual TConfigurationBuilder WithConfiguration(GitVersionConfiguration v
         WithTrackMergeTarget(value.TrackMergeTarget);
         WithTrackMergeMessage(value.TrackMergeMessage);
         WithCommitMessageIncrementing(value.CommitMessageIncrementing);
-        WithRegex(value.Regex);
+        WithRegularExpression(value.RegularExpression);
         WithTracksReleaseBranches(value.TracksReleaseBranches);
         WithIsReleaseBranch(value.IsReleaseBranch);
         WithIsMainline(value.IsMainline);
@@ -369,7 +369,7 @@ public virtual GitVersionConfiguration Build()
             VersioningMode = this.versioningMode,
             Label = this.label,
             Increment = this.increment,
-            Regex = this.regex,
+            RegularExpression = this.regularExpression,
             TracksReleaseBranches = this.tracksReleaseBranches,
             TrackMergeTarget = this.trackMergeTarget,
             TrackMergeMessage = this.trackMergeMessage,
@@ -406,7 +406,7 @@ private static void FinalizeConfiguration(GitVersionConfiguration configuration)
     }
 
     private static void FinalizeBranchConfiguration(GitVersionConfiguration configuration, string branchName,
-        BranchConfiguration branchConfiguration)
+        IBranchConfiguration branchConfiguration)
     {
 
         var branches = new Dictionary<string, BranchConfiguration>(configuration.Branches);
@@ -423,7 +423,7 @@ private static void ValidateConfiguration(GitVersionConfiguration configuration)
         {
             var helpUrl = $"{System.Environment.NewLine}See https://gitversion.net/docs/reference/configuration for more info";
 
-            if (branchConfiguration.Regex == null)
+            if (branchConfiguration.RegularExpression == null)
             {
                 throw new ConfigurationException($"Branch configuration '{name}' is missing required configuration 'regex'{helpUrl}");
             }