refactor(core): neutral merge-requests ref API and single prefix source

Author: jduarteamaggi

src/GitVersion.Core/Core/GitPreparer.cs

@@ -236,8 +236,8 @@ private void EnsureHeadIsAttachedToBranch(string? currentBranchName, Authenticat
         var matchingCurrentBranch = !currentBranchName.IsNullOrEmpty()
             ? localBranchesWhereCommitShaIsHead.SingleOrDefault(b =>
             {
-                if (ReferenceName.TryParseGitLabMergeRequestRef(currentBranchName, out var iid))
-                    return b.Name.Canonical == ReferenceName.LocalBranchPrefix + ReferenceName.GitLabMergeRequestFriendlyName(iid);
+                if (ReferenceName.TryParseMergeRequestsRef(currentBranchName, out var mergeRequestId))
+                    return b.Name.Canonical == ReferenceName.LocalBranchPrefix + ReferenceName.MergeRequestsRefFriendlyName(mergeRequestId);
                 return b.Name.Canonical.Replace("/heads/", "/") == currentBranchName.Replace("/heads/", "/");
             })
             : null;
@@ -385,8 +385,8 @@ public void EnsureLocalBranchExistsForCurrentBranch(IRemote remote, string? curr
         const string referencePrefix = "refs/";
         var isLocalBranch = currentBranch.StartsWith(ReferenceName.LocalBranchPrefix);
         string localCanonicalName;
-        if (ReferenceName.TryParseGitLabMergeRequestRef(currentBranch, out var gitLabIid))
-            localCanonicalName = ReferenceName.LocalBranchPrefix + ReferenceName.GitLabMergeRequestFriendlyName(gitLabIid);
+        if (ReferenceName.TryParseMergeRequestsRef(currentBranch, out var mergeRequestId))
+            localCanonicalName = ReferenceName.LocalBranchPrefix + ReferenceName.MergeRequestsRefFriendlyName(mergeRequestId);
         else
             localCanonicalName = !currentBranch.StartsWith(referencePrefix)
                 ? ReferenceName.LocalBranchPrefix + currentBranch

src/GitVersion.Core/Core/RepositoryStore.cs

@@ -73,9 +73,9 @@ public IBranch GetTargetBranch(string? targetBranchName)
         if (targetBranchName.IsNullOrEmpty())
             return desiredBranch;
 
-        if (ReferenceName.TryParseGitLabMergeRequestRef(targetBranchName, out var gitLabIid))
+        if (ReferenceName.TryParseMergeRequestsRef(targetBranchName, out var mergeRequestId))
         {
-            var prBranch = FindBranch(ReferenceName.GitLabMergeRequestFriendlyName(gitLabIid));
+            var prBranch = FindBranch(ReferenceName.MergeRequestsRefFriendlyName(mergeRequestId));
             if (prBranch != null)
                 return prBranch;
         }

src/GitVersion.Core/Git/ReferenceName.cs

@@ -23,7 +23,12 @@ public class ReferenceName : IEquatable<ReferenceName?>, IComparable<ReferenceNa
         "refs/remotes/pull-requests/"
     ];
 
-    private const string GitLabMergeRequestRefPrefix = "refs/merge-requests/";
+    /// <summary>
+    ///     The sole <see cref="PullRequestPrefixes" /> entry for <c>refs/merge-requests/&lt;id&gt;/head|merge</c>.
+    ///     Adding another prefix that also contains <c>/merge-requests/</c> will fail at type initialization.
+    /// </summary>
+    private static readonly string mergeRequestsRefPrefix = PullRequestPrefixes.Single(
+        p => p.Contains("/merge-requests/", StringComparison.Ordinal));
 
     public ReferenceName(string canonical)
     {
@@ -88,23 +93,27 @@ public bool EquivalentTo(string? name) =>
         || WithoutOrigin.Equals(name, StringComparison.OrdinalIgnoreCase);
 
     /// <summary>
-    /// Detects GitLab MR ref (refs/merge-requests/&lt;iid&gt;/head or /merge) and extracts IID for pull-requests config.
+    /// Parses canonical refs under refs/merge-requests/&lt;id&gt;/head or /merge (convention used by some Git hosts) and extracts the merge-request id.
     /// </summary>
-    public static bool TryParseGitLabMergeRequestRef(string? canonicalRef, out int iid)
+    public static bool TryParseMergeRequestsRef(string? canonicalRef, out int mergeRequestId)
     {
-        iid = 0;
-        if (string.IsNullOrEmpty(canonicalRef) || !canonicalRef.StartsWith(GitLabMergeRequestRefPrefix, StringComparison.Ordinal))
+        mergeRequestId = 0;
+        if (string.IsNullOrEmpty(canonicalRef) || !canonicalRef.StartsWith(mergeRequestsRefPrefix, StringComparison.Ordinal))
             return false;
-        var after = canonicalRef.Substring(GitLabMergeRequestRefPrefix.Length);
+        var after = canonicalRef.Substring(mergeRequestsRefPrefix.Length);
         var slash = after.IndexOf('/');
         if (slash <= 0 || slash >= after.Length - 1) return false;
         var suffix = after[(slash + 1)..];
         if (!suffix.Equals("head", StringComparison.OrdinalIgnoreCase) && !suffix.Equals("merge", StringComparison.OrdinalIgnoreCase))
             return false;
-        return int.TryParse(after.Substring(0, slash), System.Globalization.NumberStyles.None, System.Globalization.CultureInfo.InvariantCulture, out iid)
-               && iid > 0;
+        return int.TryParse(after.Substring(0, slash), System.Globalization.NumberStyles.None, System.Globalization.CultureInfo.InvariantCulture, out mergeRequestId);
     }
 
+    /// <summary>
+    /// Returns the branch-style name pull-requests/&lt;id&gt; for default pull-request configuration matching.
+    /// </summary>
+    public static string MergeRequestsRefFriendlyName(int mergeRequestId) => $"pull-requests/{mergeRequestId}";
+
     private string Shorten()
     {
         if (IsLocalBranch)
@@ -116,8 +125,8 @@ private string Shorten()
         if (IsTag)
             return Canonical[TagPrefix.Length..];
 
-        if (TryParseGitLabMergeRequestRef(Canonical, out var iid))
-            return $"pull-requests/{iid}";
+        if (TryParseMergeRequestsRef(Canonical, out var mergeRequestId))
+            return MergeRequestsRefFriendlyName(mergeRequestId);
 
         return Canonical;
     }

src/GitVersion.Core/PublicAPI.Unshipped.txt

@@ -1 +1,3 @@
 #nullable enable
+static GitVersion.Git.ReferenceName.MergeRequestsRefFriendlyName(int mergeRequestId) -> string!
+static GitVersion.Git.ReferenceName.TryParseMergeRequestsRef(string? canonicalRef, out int mergeRequestId) -> bool

src/GitVersion.LibGit2Sharp/Git/GitRepository.mutating.cs

@@ -70,8 +70,8 @@ public void CreateBranchForPullRequestBranch(AuthenticationInfo auth) => Reposit
         }
         else if (referenceName.IsPullRequest)
         {
-            var fakeBranchName = ReferenceName.TryParseGitLabMergeRequestRef(canonicalName, out var gitLabIid)
-                ? $"{ReferenceName.LocalBranchPrefix}{ReferenceName.GitLabMergeRequestFriendlyName(gitLabIid)}"
+            var fakeBranchName = ReferenceName.TryParseMergeRequestsRef(canonicalName, out var mergeRequestId)
+                ? $"{ReferenceName.LocalBranchPrefix}{ReferenceName.MergeRequestsRefFriendlyName(mergeRequestId)}"
                 : canonicalName.Replace("refs/pull/", "refs/heads/pull/").Replace("refs/pull-requests/", "refs/heads/pull-requests/");
 
             this.log.Info($"Creating fake local branch '{fakeBranchName}'.");