Merge branch 'feature/fix_fallback_branches' of https://github.com/pwiens/GitVersion into feature/fix_fallback_branches

Author: pwiens

.gitignore

@@ -113,3 +113,5 @@ src/GitVersionTfsTask/*.js
 /tools
 /*.zip
 GitVersion.CommandLine/*/
+
+releaseArtifacts

BREAKING CHANGES.md

@@ -8,6 +8,7 @@ v4.0.0
     - The default keys are: master, develop, feature, release, pull-request, hotfix, support
     - Just run GitVersion.exe in your project directory and it will tell you what to change your config keys to
     - For example, `dev(elop)?(ment)?$` is now just `develop`, we suggest not overring regex's unless you really want to use a different convention.
+ - source-branches added as a configuration option for branches, it helps GitVersion pick the correct source branch
 
 v3.0.0
  - NextVersion.txt has been deprecated, only GitVersionConfig.yaml is supported

Dockerfile

@@ -6,8 +6,7 @@ ARG GitVersionZip
 # Add GitVersion
 
 ADD ./releaseArtifacts/$GitVersionZip .
-RUN unzip -d /usr/lib/GitVersion/ $GitVersionZip
-RUN rm $GitVersionZip
+RUN unzip -d /usr/lib/GitVersion/ $GitVersionZip && rm $GitVersionZip
 WORKDIR /usr/lib/GitVersion/
 
 # Libgit2 can't resolve relative paths, patch to absolute path
@@ -16,4 +15,4 @@ RUN sed -i 's|lib/linux/x86_64|/usr/lib/GitVersion/lib/linux/x86_64|g' /usr/lib/
 RUN mkdir /repo
 VOLUME /repo
 
-ENTRYPOINT ["mono", "./GitVersion.exe", "/repo"]
+ENTRYPOINT ["mono", "./GitVersion.exe", "/repo"]

appveyor.deploy.yml

@@ -1,5 +1,14 @@
+image: Visual Studio 2017
+
+environment:
+  DOCKER_USERNAME:
+    secure: EbFuNVc5k/p9AiaBmS839D4GqsNaMlJ3djyRR5b2fjM=
+  DOCKER_PASSWORD:
+    secure: kweTIFTVyAVyKlvcIvgffpNa6qK8wyWAekVgue8WFqI=
+
 install:
-  npm i -g tfx-cli
+  - npm i -g tfx-cli
+  - docker version
 
 assembly_info:
   patch: false

deploy.cake

@@ -1,6 +1,8 @@
 #addin "Cake.Json"
+#addin "Cake.Docker"
 
 var target = Argument("target", "Deploy");
+var tagOverride = Argument("TagOverride", "");
 
 using System.Net;
 using System.Linq;
@@ -25,6 +27,13 @@ string Get(string url)
 Task("EnsureRequirements")
     .Does(() =>
     {
+        // This allows us to test deployments locally..
+        if (!string.IsNullOrWhiteSpace(tagOverride))
+        {
+            tag = tagOverride;
+            return;
+        }
+
         if (!AppVeyor.IsRunningOnAppVeyor)
            throw new Exception("Deployment should happen via appveyor");
 
@@ -42,8 +51,12 @@ Task("UpdateVersionInfo")
     .IsDependentOn("EnsureRequirements")
     .Does(() =>
     {
-        tag = AppVeyor.Environment.Repository.Tag.Name;
-        AppVeyor.UpdateBuildVersion(tag);
+        // Will not be empty if overriden
+        if (tag == "")
+        {
+            tag = AppVeyor.Environment.Repository.Tag.Name;
+            AppVeyor.UpdateBuildVersion(tag);
+        }
     });
 
 Task("DownloadGitHubReleaseArtifacts")
@@ -180,23 +193,43 @@ Task("Publish-DockerImage")
     .IsDependentOn("DownloadGitHubReleaseArtifacts")
     .Does(() =>
 {
+    var username = EnvironmentVariable("DOCKER_USERNAME");
+    var password = EnvironmentVariable("DOCKER_PASSWORD");
+    if (string.IsNullOrEmpty(username) || string.IsNullOrEmpty(password))
+    {
+        Warning("Skipping docker publish due to missing credentials");
+        return;
+    }
+
     var returnCode = StartProcess("docker", new ProcessSettings
     {
-        Arguments = "build . --build-arg GitVersionZip=" + artifactLookup["zip"] + " --tag gittools/gitversion"
+        Arguments = "build . --build-arg GitVersionZip=" + artifactLookup["zip"] + " --tag gittools/gitversion:" + tag
     });
     if (returnCode != 0) {
         Information("Publish-DockerImage Task failed to build image, but continuing with next Task...");
         publishingError = true;
+        return;
+    }
+
+    returnCode = StartProcess("docker", new ProcessSettings
+    {
+        Arguments = "run -v " + System.IO.Directory.GetCurrentDirectory() + ":/repo gittools/gitversion:" + tag
+    });
+    if (returnCode != 0) {
+        Information("Publish-DockerImage Task failed to run built image, but continuing with next Task...");
+        publishingError = true;
+        return;
     }
 
     // Login to dockerhub
     returnCode = StartProcess("docker", new ProcessSettings
     {
-        Arguments = "login -u=\"" + EnvironmentVariable("DOCKER_USERNAME") +"\" -p=\"" + EnvironmentVariable("DOCKER_PASSWORD") +"\""
+        Arguments = "login -u=\"" + username +"\" -p=\"" + password +"\""
     });
     if (returnCode != 0) {
         Information("Publish-DockerImage Task failed to login, but continuing with next Task...");
         publishingError = true;
+        return;
     }
 
     // Publish Tag
@@ -207,10 +240,19 @@ Task("Publish-DockerImage")
     if (returnCode != 0) {
         Information("Publish-DockerImage Task failed push version tag, but continuing with next Task...");
         publishingError = true;
+        return;
     }
 
     // Publish latest
     returnCode = StartProcess("docker", new ProcessSettings
+    {
+        Arguments = "tag gittools/gitversion:" + tag + " gittools/gitversion:latest"
+    });
+    if (returnCode != 0) {
+        Information("Publish-DockerImage Task failed latest tag, but continuing with next Task...");
+        publishingError = true;
+    }
+    returnCode = StartProcess("docker", new ProcessSettings
     {
         Arguments = "push gittools/gitversion:latest"
     });

docs/configuration.md

@@ -243,6 +243,70 @@ values, but here they are if you need to:
 ### regex
 This is the regex which is used to match the current branch to the correct branch configuration.
 
+### source-branches
+Because git commits only refer to parent commits (not branches) GitVersion sometimes cannot tell which branch the current branch was branched from.
+
+Take this commit graph
+
+```
+* release/1.0.0   * feature/foo
+| ________________/
+|/
+*
+*
+* (master)
+```
+
+By looking at this graph, you cannot tell which of these scenarios happened:
+
+1. feature/foo branches off release/1.0.0
+   - Branch release/1.0.0 from master
+   - Branch feature/foo from release/1.0.0
+   - Add a commit to both release/1.0.0 and feature/foo
+   - release/1.0.0 is the base for feature/foo
+
+2. release/1.0.0 branches off feature/foo
+   - Branch feature/foo from master
+   - Branch release/1.0.0 from feature/foo 
+   - Add a commit to both release/1.0.0 and feature/foo
+   - feature/foo is the base for release/1.0.0
+
+Or put more simply, you cannot tell which branch was created first, `release/1.0.0` or `feature/foo`.
+
+To resolve this issue, we give GitVersion a hint about our branching workflows by telling it what types of branches a branch can be created from. For example, feature branches are, by default, configured to have the following source branches:
+
+`source-branches: ['master', 'develop', 'feature', 'hotfix', 'support']`
+
+This means that we will never bother to evaluate pull request branches as merge base options and being explicit in this way also improves the performance of GitVersion.
+
+### is-source-branch-for
+The reverse of `source-branches`. This property was introduced to keep it easy to extend GitVersion's config.
+
+It exists to make it easier to extend GitVersion's configuration. If only `source-branches` exists and you add a new branch type, for instance `unstable/`, you then need to re-define the `source-branches` configuration value for existing branches (like feature/) to now include the new unstable branch.
+
+A complete example:
+
+```
+branches:
+  unstable:
+    regex: ...
+    is-source-branch-for: ['master', 'develop', 'feature', 'hotfix', 'support']
+```
+
+Without this configuration value you would have to do:
+
+
+```
+branches:
+  unstable:
+    regex: ...
+  feature:
+    source-branches: ['unstable', 'develop', 'feature', 'hotfix', 'support']
+  release:
+    source-branches: ['unstable', 'develop']
+  etc...
+```
+
 ### branches
 The header for all the individual branch configuration.
 

docs/why.md

@@ -6,7 +6,7 @@ It solves:
  - Rebuilding tags always produces the same version
  - Not having to rebuild to increment versions
  - Not duplicating version information in multiple places (branch release/2.0.0 already has the version in it, why do I need to change something else)
- - Each branch calculates it's SemVer and versions flow between branches when they are merged
+ - Each branch calculates its SemVer and versions flow between branches when they are merged
  - Pull requests produce unique pre-release version numbers
  - NuGet semver issues
  - Build server integration

mkdocs.yml

@@ -55,5 +55,5 @@ pages:
   - Versioning modes:
     - Versioning modes: reference/versioning-mode.md
     - Mainline development: reference/mainline-development.md
-    - Continous delivery: reference/continuous-delivery.md
+    - Continuous delivery: reference/continuous-delivery.md
     - Continuous deployment: reference/continuous-deployment.md

src/DockerBase/Dockerfile

@@ -1,13 +1,10 @@
-FROM ubuntu
+FROM ubuntu:16.04
 
 MAINTAINER GitTools Maintainers <jake@ginnivan.net>
 
 # Wheezy doesn't support glibc 2.15 which libgit2sharp requires
 # So we are going to install mono on ubuntu instead
 RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
-RUN apt-get update
-RUN apt-get install libcurl3 tzdata unzip curl git-all -y
 RUN echo "deb http://download.mono-project.com/repo/debian wheezy main" | tee /etc/apt/sources.list.d/mono-xamarin.list
-RUN apt-get update
-RUN apt-get install mono-complete -y
+RUN apt-get update && apt-get install libcurl3 tzdata unzip curl git-all mono-complete -y && apt-get -yqq clean
 RUN cp /usr/share/zoneinfo/GMT /etc/localtime

src/GitVersionCore.Tests/BuildServers/VsoAgentBuildNumberTests.cs

@@ -0,0 +1,67 @@
+using System;
+using GitVersion;
+using GitVersionCore.Tests;
+using NUnit.Framework;
+using Shouldly;
+using System.Collections.Generic;
+
+[TestFixture]
+public class VsoAgentBuildNumberTests
+{
+    string key = "BUILD_BUILDNUMBER";
+    string logPrefix = "##vso[build.updatebuildnumber]";
+    List<Tuple<string, string, string>> examples;
+    VsoAgent versionBuilder = new VsoAgent();
+
+    [SetUp]
+    public void SetUpVsoAgentBuildNumberTest()
+    {
+         examples = new List<Tuple<string, string, string>>();
+    }
+
+    [TearDown]
+    public void TearDownVsoAgentBuildNumberTest()
+    {
+        examples = null;
+        Environment.SetEnvironmentVariable(key, null, EnvironmentVariableTarget.Process);
+    }
+
+
+    [Test]
+    public void VsoAgentBuildNumberWithFullSemVer()
+    {
+        examples.Add(new Tuple<string, string, string>("$(GitVersion.FullSemVer)", "1.0.0", "1.0.0"));
+        examples.Add(new Tuple<string, string, string>("$(GITVERSION_FULLSEMVER)", "1.0.0", "1.0.0"));
+        examples.Add(new Tuple<string, string, string>("$(GitVersion.FullSemVer)-Build.1234", "1.0.0", "1.0.0-Build.1234"));
+        examples.Add(new Tuple<string, string, string>("$(GITVERSION_FULLSEMVER)-Build.1234", "1.0.0", "1.0.0-Build.1234"));
+
+        foreach (var example in examples)
+        {
+            Environment.SetEnvironmentVariable(key, example.Item1, EnvironmentVariableTarget.Process);
+            var vars = new TestableVersionVariables(fullSemVer: example.Item2);
+
+            var logMessage = versionBuilder.GenerateSetVersionMessage(vars);
+            logMessage.ShouldBe(logPrefix + example.Item3);
+        }
+    }
+
+
+    [Test]
+    public void VsoAgentBuildNumberWithSemVer()
+    {
+        examples.Add(new Tuple<string, string, string>("$(GitVersion.SemVer)", "1.0.0", "1.0.0"));
+        examples.Add(new Tuple<string, string, string>("$(GITVERSION_SEMVER)", "1.0.0", "1.0.0"));
+        examples.Add(new Tuple<string, string, string>("$(GitVersion.SemVer)-Build.1234", "1.0.0", "1.0.0-Build.1234"));
+        examples.Add(new Tuple<string, string, string>("$(GITVERSION_SEMVER)-Build.1234", "1.0.0", "1.0.0-Build.1234"));
+
+        foreach (var example in examples)
+        {
+            Environment.SetEnvironmentVariable(key, example.Item1, EnvironmentVariableTarget.Process);
+            var vars = new TestableVersionVariables(semVer: example.Item2);
+
+            var logMessage = versionBuilder.GenerateSetVersionMessage(vars);
+            logMessage.ShouldBe(logPrefix + example.Item3);
+        }
+    }
+
+}