Add support for Jenkins Pipeline (multi-branch)

Author: erik-am

src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt

@@ -46,7 +46,7 @@ branches:
     tag: PullRequest
     increment: Inherit
     prevent-increment-of-merged-branch-version: false
-    tag-number-pattern: '[/-](?<number>\d+)[-/]'
+    tag-number-pattern: '[/-](?<number>\d+)'
     track-merge-target: false
     regex: (pull|pull\-requests|pr)[/-]
     tracks-release-branches: false

src/GitVersionCore/BuildServers/BuildServerBase.cs

@@ -33,5 +33,10 @@ public virtual void WriteIntegration(Action<string> writer, VersionVariables var
                 writer(buildParameter);
             }
         }
+
+        public virtual bool ShouldCleanUpRemotes()
+        {
+            return false;
+        }
     }
 }

src/GitVersionCore/BuildServers/IBuildServer.cs

@@ -13,5 +13,6 @@ public interface IBuildServer
         /// If the build server should not try and fetch
         /// </summary>
         bool PreventFetch();
+        bool ShouldCleanUpRemotes();
     }
 }

src/GitVersionCore/BuildServers/Jenkins.cs

@@ -36,14 +36,31 @@ public override string[] GenerateSetParameterMessage(string name, string value)
 
         public override string GetCurrentBranch(bool usingDynamicRepos)
         {
-            return Environment.GetEnvironmentVariable("GIT_LOCAL_BRANCH") ?? Environment.GetEnvironmentVariable("GIT_BRANCH");
+            return IsPipelineAsCode()
+                ? Environment.GetEnvironmentVariable("BRANCH_NAME")
+                : (Environment.GetEnvironmentVariable("GIT_LOCAL_BRANCH") ?? Environment.GetEnvironmentVariable("GIT_BRANCH"));
+        }
+
+        private bool IsPipelineAsCode()
+        {
+            return !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("BRANCH_NAME"));
         }
 
         public override bool PreventFetch()
         {
             return true;
         }
 
+        /// <summary>
+        /// When Jenkins uses pipeline-as-code, it creates two remotes: "origin" and "origin1".
+        /// This should be cleaned up, so that normizaling the Git repo will not fail.
+        /// </summary>
+        /// <returns></returns>
+        public override bool ShouldCleanUpRemotes()
+        {
+            return IsPipelineAsCode();
+        }
+
         public override void WriteIntegration(Action<string> writer, VersionVariables variables)
         {
             base.WriteIntegration(writer, variables);

src/GitVersionCore/Configuration/ConfigurationProvider.cs

@@ -122,7 +122,7 @@ public static void ApplyDefaultsTo(Config config)
                 GetOrCreateBranchDefaults(config, PullRequestBranchKey),
                 PullRequestRegex,
                 defaultTag: "PullRequest",
-                defaultTagNumberPattern: @"[/-](?<number>\d+)[-/]",
+                defaultTagNumberPattern: @"[/-](?<number>\d+)",
                 defaultIncrementStrategy: IncrementStrategy.Inherit);
             ApplyBranchDefaults(config,
                 GetOrCreateBranchDefaults(config, HotfixBranchKey),

src/GitVersionCore/ExecuteCore.cs

@@ -25,8 +25,9 @@ public VersionVariables ExecuteGitVersion(string targetUrl, string dynamicReposi
             var applicableBuildServers = BuildServerList.GetApplicableBuildServers();
             var buildServer = applicableBuildServers.FirstOrDefault();
             var fetch = noFetch || (buildServer != null && buildServer.PreventFetch());
+            var shouldCleanUpRemotes = buildServer != null && buildServer.ShouldCleanUpRemotes();
             var gitPreparer = new GitPreparer(targetUrl, dynamicRepositoryLocation, authentication, fetch, workingDirectory);
-            gitPreparer.Initialise(buildServer != null, ResolveCurrentBranch(buildServer, targetBranch, !string.IsNullOrWhiteSpace(dynamicRepositoryLocation)));
+            gitPreparer.Initialise(buildServer != null, ResolveCurrentBranch(buildServer, targetBranch, !string.IsNullOrWhiteSpace(dynamicRepositoryLocation)), shouldCleanUpRemotes);
             var dotGitDirectory = gitPreparer.GetDotGitDirectory();
             var projectRoot = gitPreparer.GetProjectRootDirectory();
 

src/GitVersionCore/GitPreparer.cs

@@ -51,14 +51,18 @@ public bool IsDynamicGitRepository
 
         public string DynamicGitRepositoryPath { get; private set; }
 
-        public void Initialise(bool normaliseGitDirectory, string currentBranch)
+        public void Initialise(bool normaliseGitDirectory, string currentBranch, bool shouldCleanUpRemotes = false)
         {
             if (string.IsNullOrWhiteSpace(targetUrl))
             {
                 if (normaliseGitDirectory)
                 {
                     using (Logger.IndentLog(string.Format("Normalizing git directory for branch '{0}'", currentBranch)))
                     {
+                        if (shouldCleanUpRemotes)
+                        {
+                            CleanupDuplicateOrigin();
+                        }
                         GitRepositoryHelper.NormalizeGitDirectory(GetDotGitDirectory(), authentication, noFetch, currentBranch);
                     }
                 }
@@ -70,6 +74,15 @@ public void Initialise(bool normaliseGitDirectory, string currentBranch)
             DynamicGitRepositoryPath = CreateDynamicRepository(tempRepositoryPath, authentication, targetUrl, currentBranch, noFetch);
         }
 
+        private void CleanupDuplicateOrigin()
+        {
+            var repo = new Repository(GetDotGitDirectory());
+            if (repo.Network.Remotes.Any(remote => remote.Name == "origin1"))
+            {
+                repo.Network.Remotes.Remove("origin1");
+            }
+        }
+
         public TResult WithRepository<TResult>(Func<IRepository, TResult> action)
         {
             using (IRepository repo = new Repository(GetDotGitDirectory()))