Merge remote-tracking branch 'upstream/master' into release/3.0.0

Author: JakeGinnivan

Docs/configurationOptions.md

@@ -1 +1 @@
-# Confiuration options
+# Configuration options

Docs/index.md renamed to Docs/readme.md

@@ -4,11 +4,6 @@ GitVersion is a tool to help you achieve Semantic Versioning on your project.
 This influences many of the decisions GitVersion has made, please read and understand this page as it will help you start using GitVersion effectively!
 
 ## Assumptions/Rules
-### You tag releases when you release, not before
-GitVersion assumes that tags are used to *tag a release* and not used to build a release.
-
-This means that the version is calculated pre-emptively, if you currently tag, build then release that tag then GitVersion will probably not work for you.
-
 ### Tags override other rules
 If a commit is tagged, then GitVersion will *always* use that version over any calculated versions. This is so if you rebuild a tag then the same version will be produced.
 
@@ -39,6 +34,6 @@ We recognise that a single formatted version number does not work for all cases.
 You can just run `GitVersion.exe` in your repository to see what variables are available (by default a json object is returned).
 
 ## Exe or MSBuild Task
-There are two ways to consume GitVersion, the first is by running GitVersion.exe. The second is an MSBUild task. The MSBuild task is really easy to get up and running, simply install GitVersionTask from NuGet and it will integrate into your project and write out variables to your build server if it's running on one. The exe offers more options and works for not just .net projects.
+There are two ways to consume GitVersion, the first is by running GitVersion.exe. The second is an MSBuild task. The MSBuild task is really easy to get up and running, simply install GitVersionTask from NuGet and it will integrate into your project and write out variables to your build server if it's running on one. The exe offers more options and works for not just .net projects.
 
 Read more about [using GitVersion](./usage.md)

Docs/versionSources.md

@@ -17,7 +17,7 @@ GitVersion will find all tags on the current branch and return the highest one.
 Will increment: true
 
 ### Version in branch name
-If the branch has a version in it, then that version will be returned
+If the branch has a version in it, then that version will be returned.
 
 Will increment: false
 
@@ -27,7 +27,7 @@ If a branch with a version number in it is merged into the current branch, that
 Will increment: false
 
 ### GitVersionConfig.yaml
-If the next-version property is specified in the config file, it will be used as a version source.
+If the `next-version` property is specified in the config file, it will be used as a version source.
 
 Will increment: false
 

GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs

@@ -86,7 +86,7 @@ public void ReleaseBranchWithNextVersionSetInConfig()
     }
 
     [Test]
-    public void CanTakeVersionFromReleaseBranchWithTagOverriden()
+    public void CanTakeVersionFromReleaseBranchWithTagOverridden()
     {
         var config = new Config();
         config.Branches["release[/-]"].Tag = "rc";

GitVersionCore.Tests/IntegrationTests/RemoteRepositoryScenarios.cs

@@ -57,7 +57,7 @@ public void GivenARemoteGitRepositoryAheadOfLocalRepository_ThenChangesShouldPul
     }
 
     [Test]
-    public void GivenARemoteGitRepositoryWhenCheckingOutDetachedhead_UsingExistingImplemenationThrowsException()
+    public void GivenARemoteGitRepositoryWhenCheckingOutDetachedhead_UsingExistingImplementationThrowsException()
     {
 
         using (var fixture = new RemoteRepositoryFixture(new Config()))

GitVersionCore.Tests/VersionCalculation/Strategies/MergeMessageBaseVersionStrategyTests.cs

@@ -81,7 +81,7 @@ Another commit message
   A commit message")]
         [TestCase(@"Merge branch 'release/Sprint_2.0_Holdings_Computed_Balances'")]
         [TestCase(@"Merge branch 'feature/fix-for-08.14-push'")]
-        public void MergeMessagesThatsNotRelatedToGitVersion(string commitMessage)
+        public void MergeMessagesThatIsNotRelatedToGitVersion(string commitMessage)
         {
 
             var parents = GetParents(true);

GitVersionCore/BuildServers/GitHelper.cs

@@ -1,5 +1,6 @@
 namespace GitVersion
 {
+    using System;
     using LibGit2Sharp;
     using System.Collections.Generic;
     using System.Linq;
@@ -164,6 +165,20 @@ static void CreateFakeBranchPointingAtThePullRequestTip(Repository repo, Authent
             repo.Checkout(fakeBranchName);
         }
 
+        internal static IEnumerable<DirectReference> GetRemoteTipsUsingUsernamePasswordCredentials(Repository repo, string repoUrl, string username, string password)
+        {
+            // This is a work-around as long as https://github.com/libgit2/libgit2sharp/issues/1099 is not fixed
+            var remote = repo.Network.Remotes.Add(Guid.NewGuid().ToString(), repoUrl);
+            try
+            {
+                return GetRemoteTipsUsingUsernamePasswordCredentials(repo, remote, username, password);
+            }
+            finally
+            {
+                repo.Network.Remotes.Remove(remote.Name);
+            }
+        }
+
         static IEnumerable<DirectReference> GetRemoteTipsUsingUsernamePasswordCredentials(Repository repo, Remote remote, string username, string password)
         {
             return repo.Network.ListReferences(remote, (url, fromUrl, types) => new UsernamePasswordCredentials
@@ -185,7 +200,9 @@ static void CreateMissingLocalBranchesFromRemoteTrackingOnes(Repository repo, st
 
             foreach (var remoteTrackingReference in repo.Refs.FromGlob(prefix + "*").Where(r => r.CanonicalName != remoteHeadCanonicalName))
             {
-                var localCanonicalName = "refs/heads/" + remoteTrackingReference.CanonicalName.Substring(prefix.Length);
+                var remoteTrackingReferenceName = remoteTrackingReference.CanonicalName;
+                var branchName = remoteTrackingReferenceName.Substring(prefix.Length);
+                var localCanonicalName = "refs/heads/" + branchName;
 
                 if (repo.Refs.Any(x => x.CanonicalName == localCanonicalName))
                 {
@@ -203,6 +220,9 @@ static void CreateMissingLocalBranchesFromRemoteTrackingOnes(Repository repo, st
                 {
                     repo.Refs.Add(localCanonicalName, new ObjectId(symbolicReference.ResolveToDirectReference().TargetIdentifier), true);
                 }
+
+                var branch = repo.Branches[branchName];
+                repo.Branches.Update(branch, b => b.TrackedBranch = remoteTrackingReferenceName);
             }
         }
 

GitVersionCore/Configuration/Wizard/EditConfigStep.cs

@@ -30,7 +30,7 @@ protected override string GetPrompt(Config config)
         {
             return string.Format(@"Which would you like to change?
 
-0) Save changes
+0) Save changes and exit
 1) Exit without saving
 2) Branch specific configuration
 3) Branch Increment mode (per commit/after tag) (Current: {0})

GitVersionCore/Configuration/Wizard/PickBranchingStrategy1Step.cs

@@ -27,7 +27,7 @@ protected override string GetPrompt(Config config)
         {
             return @"GitVersion can try to recommend you a branching strategy based on a few questions. 
 
-Do you need to maintain mutliple versions of your application simultanously in production? (y/n)";
+Do you need to maintain multiple versions of your application simultaneously in production? (y/n)";
         }
 
         protected override string DefaultResult

GitVersionCore/Configuration/Wizard/PickBranchingStrategy2Step.cs

@@ -13,9 +13,9 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard
                     Console.WriteLine("GitFlow is likely a good fit, the 'develop' branch can be used " +
                                       "for active development while stabilising the next release.");
                     Console.WriteLine();
-                    Console.WriteLine("GitHubFlow is designed for a lightwieght workflow where master is always " +
+                    Console.WriteLine("GitHubFlow is designed for a lightweight workflow where master is always " +
                                       "good to deploy to production and feature branches are used to stabilise " +
-                                      "features, once stable they can be released in the next release");
+                                      "features, once stable they are merged to master and made available in the next release");
                     steps.Enqueue(new PickBranchingStrategyStep());
                     return StepResult.Ok();
                 case "n":

GitVersionCore/Configuration/Wizard/PickBranchingStrategy3Step.cs

@@ -13,7 +13,7 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard
                     Console.WriteLine("GitFlow could be a better fit than GitHubFlow for you.");
                     Console.WriteLine();
                     Console.WriteLine("GitVersion increments the SemVer for each commit on the develop branch by default, " +
-                                      "this means all packages build from develop can be published to a single NuGet feed.");
+                                      "this means all packages built from develop can be published to a single NuGet feed.");
                     break;
                 case "n":
                     Console.WriteLine("We recommend the GitHubFlow branching strategy, it sounds like you will " +

GitVersionCore/Configuration/Wizard/SetBranchIncrementMode.cs

@@ -35,7 +35,7 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard
 
         protected override string GetPrompt(Config config)
         {
-            return string.Format(@"What do you want the increment mode for {0} to be
+            return string.Format(@"What do you want the increment mode for {0} to be?
 
 0) Back
 1) Follow SemVer and only increment when a release has been tagged (continuous delivery mode)

GitVersionCore/Configuration/Wizard/SetBranchTag.cs

@@ -9,8 +9,8 @@ public class SetBranchTag : ConfigInitWizardStep
 
         public SetBranchTag(string name, BranchConfig branchConfig)
         {
-            this.branchConfig = branchConfig;
             this.name = name;
+            this.branchConfig = branchConfig;
         }
 
         protected override StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config)

GitVersionCore/Configuration/Wizard/SimpleOrTutorialStep.cs

@@ -20,7 +20,7 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard
 
         protected override string GetPrompt(Config config)
         {
-            return "Would you like to run an extended init (more like a tutorial) (y/n)";
+            return "Would you like to run an extended init? (more like a tutorial) (y/n)";
         }
 
         protected override string DefaultResult

GitVersionCore/GitPreparer.cs

@@ -172,7 +172,7 @@ static string CreateDynamicRepository(string targetPath, Authentication authenti
 
                 if (newHead == null)
                 {
-                    var remoteReference = GetRemoteReference(repository, targetBranch, repositoryUrl);
+                    var remoteReference = GetRemoteReference(repository, targetBranch, repositoryUrl, authentication);
                     if (remoteReference != null)
                     {
                         repository.Network.Fetch(repositoryUrl, new[]
@@ -202,11 +202,11 @@ private static Reference GetLocalReference(Repository repository, string branchN
             return repository.Refs.FirstOrDefault(localRef => string.Equals(localRef.CanonicalName, targetBranchName));
         }
 
-        private static DirectReference GetRemoteReference(Repository repository, string branchName, string repositoryUrl)
+        private static DirectReference GetRemoteReference(Repository repository, string branchName, string repositoryUrl, Authentication authentication)
         {
             var targetBranchName = branchName.GetCanonicalBranchName();
-            var remoteReferences = repository.Network.ListReferences(repositoryUrl);
 
+            var remoteReferences = GitHelper.GetRemoteTipsUsingUsernamePasswordCredentials(repository, repositoryUrl, authentication.Username, authentication.Password);
             return remoteReferences.FirstOrDefault(remoteRef => string.Equals(remoteRef.CanonicalName, targetBranchName));
         }
     }

GitVersionCore/LibGitExtensions.cs

@@ -121,7 +121,7 @@ public static void CheckoutFilesIfExist(this IRepository repository, params stri
                 return;
             }
 
-            Logger.WriteInfo(string.Format("Checking out files that might be needed later in dynamic repository"));
+            Logger.WriteInfo("Checking out files that might be needed later in dynamic repository");
 
             foreach (var fileName in fileNames)
             {

GitVersionExe.Tests/GitPreparerTests.cs

@@ -208,5 +208,41 @@ public void UsesGitVersionConfigWhenCreatingDynamicRepository()
         }
     }
 
+    [Test]
+    public void UsingDynamicRepositoryWithFeatureBranchWorks()
+    {
+        var repoName = Guid.NewGuid().ToString();
+        var tempPath = Path.GetTempPath();
+        var tempDir = Path.Combine(tempPath, repoName);
+        Directory.CreateDirectory(tempDir);
+
+        try
+        {
+            using (var mainRepositoryFixture = new EmptyRepositoryFixture(new Config()))
+            {
+                var commitId = mainRepositoryFixture.Repository.MakeACommit().Id.Sha;
+
+                var arguments = new Arguments
+                {
+                    TargetPath = tempDir,
+                    TargetUrl = mainRepositoryFixture.RepositoryPath,
+                    TargetBranch = "feature1",
+                    CommitId = commitId
+                };
+
+                var gitPreparer = new GitPreparer(arguments.TargetUrl, arguments.DynamicRepositoryLocation, arguments.Authentication, arguments.TargetBranch, arguments.NoFetch, arguments.TargetPath);
+                gitPreparer.Initialise(true);
+
+                mainRepositoryFixture.Repository.CreateBranch("feature1").Checkout();
+
+                Assert.DoesNotThrow(() => gitPreparer.Initialise(true));
+            }
+        }
+        finally
+        {
+            Directory.Delete(tempDir, true);
+        }
+    }
+
     // TODO test around normalisation
 }