Teach Repository.Clone to accept a specific branch to checkout

ekk8 · nulltoken · commit bf464cf8a992 · 2014-12-05T21:32:34.000+01:00
diff --git a/LibGit2Sharp.Tests/CloneFixture.cs b/LibGit2Sharp.Tests/CloneFixture.cs
@@ -36,6 +36,26 @@ public void CanClone(string url)
             }
         }
 
+        [Theory]
+        [InlineData("br2", "a4a7dce85cf63874e984719f4fdd239f5145052f")]
+        [InlineData("packed", "41bc8c69075bbdb46c5c6f0566cc8cc5b46e8bd9")]
+        [InlineData("test", "e90810b8df3e80c413d903f631643c716887138d")]
+        public void CanCloneWithCheckoutBranchName(string branchName, string headTipId)
+        {
+            var scd = BuildSelfCleaningDirectory();
+
+            string clonedRepoPath = Repository.Clone(BareTestRepoPath, scd.DirectoryPath, new CloneOptions { BranchName = branchName });
+
+            using (var repo = new Repository(clonedRepoPath))
+            {
+                var head = repo.Head;
+
+                Assert.Equal(branchName, head.Name);
+                Assert.True(head.IsTracking);
+                Assert.Equal(headTipId, head.Tip.Sha);
+            }
+        }
+
         private void AssertLocalClone(string url, string path = null, bool isCloningAnEmptyRepository = false)
         {
             var scd = BuildSelfCleaningDirectory();
diff --git a/LibGit2Sharp/CloneOptions.cs b/LibGit2Sharp/CloneOptions.cs
@@ -28,6 +28,12 @@ public CloneOptions()
         /// </summary>
         public bool Checkout { get; set; }
 
+        /// <summary>
+        /// The name of the branch to checkout. When unspecified the
+        /// remote's default branch will be used instead.
+        /// </summary>
+        public string BranchName { get; set; }
+
         /// <summary>
         /// Handler for checkout progress information.
         /// </summary>
diff --git a/LibGit2Sharp/Repository.cs b/LibGit2Sharp/Repository.cs
@@ -553,6 +553,7 @@ public static string Clone(string sourceUrl, string workdirPath,
                     Bare = options.IsBare ? 1 : 0,
                     CheckoutOpts = gitCheckoutOptions,
                     RemoteCallbacks = gitRemoteCallbacks,
+                    CheckoutBranch = StrictUtf8Marshaler.FromManaged(options.BranchName)
                 };
 
                 FilePath repoPath;
