Merge branch 'master' into feature/dynamic

Author: GeertvanHorrik

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "program": "${workspaceRoot}/tools/Cake.CoreCLR/Cake.dll",
+            "args": [
+                "${workspaceRoot}/build.cake",
+                "--debug",
+                "--verbosity=diagnostic"
+            ],
+            "cwd": "${workspaceRoot}",
+            "stopAtEntry": true,
+            "externalConsole": false
+        }
+    ]
+}

README.md

@@ -1,36 +1,86 @@
-![Icon](https://raw.github.com/GitTools/GitVersion/master/docs/img/package_icon.png)
+![Icon][icon]
+
 # GitVersion
-Versioning when using git, solved. GitVersion looks at your git history and works out the semantic version ([semver.org](http://semver.org)) of the commit being built.
+Versioning when using git, solved. GitVersion looks at your git history and
+works out the [semantic version][semver] of the commit being built.
+
+[![Gitter][gitter-badge]][gitter]
+[![Build status][appveyor-badge]][appveyor]
+[![Build Status][travis-badge]][travis]
+
+|                            |                Stable               |                 Pre-release               |
+| -------------------------: | :---------------------------------: | :---------------------------------------: |
+|                  **Docs**  |     [![Docs][docs-badge]][docs]     |    [![Docs][docs-pre-badge]][docs-pre]    |
+|        **GitHub Release**  |                 -                   | [![GitHub release][gh-rel-badge]][gh-rel] |
+|   **GitVersion.Portable**  | [![Chocolatey][choco-badge]][choco] |   [![Chocolatey][choco-pre-badge]][choco] |
+|        **GitVersionTask**  |     [![NuGet][gvt-badge]][gvt]      |       [![NuGet][gvt-pre-badge]][gvt]      |
+| **GitVersion.CommandLine** |     [![NuGet][gvc-badge]][gvc]      |       [![NuGet][gvc-pre-badge]][gvc]      |
+|                    **Gem** |       [![Gem][gem-badge]][gem]      |                      -                    |
+|               **Homebrew** |   [![homebrew][brew-badge]][brew]   |                      -                    |
 
-[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Build status](https://ci.appveyor.com/api/projects/status/sxje0wht0cscmn7w/branch/master?svg=true)](https://ci.appveyor.com/project/GitTools/gitversion/branch/master)
-[![Build Status](https://travis-ci.org/GitTools/GitVersion.svg?branch=master)](https://travis-ci.org/GitTools/GitVersion)
+## Compatibility
+GitVersion works on Mac, Linux with Mono and Windows.
 
-||Stable|Pre-release|
-|:--:|:--:|:--:|
-|Docs|[![Documentation Status](https://readthedocs.org/projects/gitversion/badge/?version=stable)](http://gitversion.readthedocs.org/en/stable/)|[![Documentation Status](https://readthedocs.org/projects/gitversion/badge/?version=latest)](http://gitversion.readthedocs.org/en/latest/)|
-|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/gittools/gitversion.svg)](https://github.com/GitTools/GitVersion/releases/latest)|
-|Chocolatey (GitVersion.Portable)|[![Chocolatey](https://img.shields.io/chocolatey/v/gitversion.portable.svg)](https://chocolatey.org/packages/GitVersion.Portable)|[![Chocolatey](https://img.shields.io/chocolatey/vpre/gitversion.portable.svg)](https://chocolatey.org/packages/GitVersion.Portable)|
-|NuGet (GitVersionTask)|[![NuGet](https://img.shields.io/nuget/v/GitVersionTask.svg)](https://www.nuget.org/packages/GitVersionTask)|[![NuGet](https://img.shields.io/nuget/vpre/GitVersionTask.svg)](https://www.nuget.org/packages/GitVersionTask)|
-|NuGet (GitVersion.CommandLine)|[![NuGet](https://img.shields.io/nuget/v/GitVersion.CommandLine.svg)](https://www.nuget.org/packages/GitVersion.CommandLine)|[![NuGet](https://img.shields.io/nuget/vpre/GitVersion.CommandLine.svg)](https://www.nuget.org/packages/GitVersion.CommandLine)|
-|Gem|[![Gem](https://img.shields.io/gem/v/gitversion.svg)](https://rubygems.org/gems/gitversion)|[![Gem](https://img.shields.io/gem/v/gitversion.svg)](https://rubygems.org/gems/gitversion)|
+Tip: If you get `System.TypeInitializationException: The type initializer for
+'LibGit2Sharp.Core.NativeMethods' threw an exception. --->
+System.DllNotFoundException: lib/linux/x86_64/libgit2-baa87df.so`
+
+You likely need to install `libcurl3`. Run `sudo get-get install libcurl3`
 
 ## Quick Links
- - [Documentation](http://gitversion.readthedocs.org/en/latest)
- - [Contributing](https://github.com/GitTools/GitVersion/blob/master/CONTRIBUTING.md)
- - [Why GitVersion](http://gitversion.readthedocs.org/en/latest/why)
- - [Usage](http://gitversion.readthedocs.org/en/latest/usage/usage/)
- - [How it works](http://gitversion.readthedocs.org/en/latest/more-info/how-it-works/)
- - [FAQ](http://gitversion.readthedocs.org/en/latest/faq/)
- - [Who is using GitVersion](http://gitversion.readthedocs.org/en/latest/who/)
+ - [Documentation][docs]
+   [Contributing][contribute]
+ - [Why GitVersion][why]
+ - [Usage][usage]
+ - [How it works][how]
+ - [FAQ][faq]
+ - [Who is using GitVersion][who]
 
 ## GitVersion in action!
-![README](https://raw.github.com/GitTools/GitVersion/master/docs/img/README.png)
+![README][gv-in-action]
 
 You are seeing:
 
  - Pull requests being built as pre-release builds
  - A branch called `release-1.0.0` producing beta v1 packages
 
 ## Icon
-<a href="http://thenounproject.com/noun/tree/#icon-No13389" target="_blank">Tree</a> designed by <a href="http://thenounproject.com/david.chapman" target="_blank">David Chapman</a> from The Noun Project
+<a href="http://thenounproject.com/noun/tree/#icon-No13389"
+target="_blank">Tree</a> designed by <a
+href="http://thenounproject.com/david.chapman" target="_blank">David Chapman</a>
+from The Noun Project
+
+[icon]:            https://raw.github.com/GitTools/GitVersion/master/docs/img/package_icon.png
+[semver]:          http://semver.org
+[gitter]:          https://gitter.im/GitTools/GitVersion?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[gitter-badge]:    https://badges.gitter.im/Join+Chat.svg
+[appveyor]:        https://ci.appveyor.com/project/GitTools/gitversion/branch/master
+[appveyor-badge]:  https://ci.appveyor.com/api/projects/status/sxje0wht0cscmn7w/branch/master?svg=true
+[travis]:          https://travis-ci.org/GitTools/GitVersion
+[travis-badge]:    https://travis-ci.org/GitTools/GitVersion.svg?branch=master
+[docs]:            http://gitversion.readthedocs.org/en/stable/
+[docs-badge]:      https://readthedocs.org/projects/gitversion/badge/?version=stable
+[docs-pre]:        http://gitversion.readthedocs.org/en/latest/
+[docs-pre-badge]:  https://readthedocs.org/projects/gitversion/badge/?version=latest
+[gh-rel]:          https://github.com/GitTools/GitVersion/releases/latest
+[gh-rel-badge]:    https://img.shields.io/github/release/gittools/gitversion.svg
+[choco]:           https://chocolatey.org/packages/GitVersion.Portable
+[choco-badge]:     https://img.shields.io/chocolatey/v/gitversion.portable.svg
+[choco-pre-badge]: https://img.shields.io/chocolatey/vpre/gitversion.portable.svg
+[gvt]:             https://www.nuget.org/packages/GitVersionTask
+[gvt-badge]:       https://img.shields.io/nuget/v/GitVersionTask.svg
+[gvt-pre-badge]:   https://img.shields.io/nuget/vpre/GitVersionTask.svg
+[gvc]:             https://www.nuget.org/packages/GitVersion.CommandLine
+[gvc-badge]:       https://img.shields.io/nuget/v/GitVersion.CommandLine.svg
+[gvc-pre-badge]:   https://img.shields.io/nuget/vpre/GitVersion.CommandLine.svg
+[gem-badge]:       https://img.shields.io/gem/v/gitversion.svg
+[gem]:             https://rubygems.org/gems/gitversion
+[brew]:            http://brew.sh/
+[brew-badge]:      https://img.shields.io/homebrew/v/gitversion.svg
+[contribute]:      https://github.com/GitTools/GitVersion/blob/master/CONTRIBUTING.md
+[why]:             http://gitversion.readthedocs.org/en/latest/why
+[usage]:           http://gitversion.readthedocs.org/en/latest/usage/usage/
+[how]:             http://gitversion.readthedocs.org/en/latest/more-info/how-it-works/
+[faq]:             http://gitversion.readthedocs.org/en/latest/faq/
+[who]:             http://gitversion.readthedocs.org/en/latest/who/
+[gv-in-action]:    https://raw.github.com/GitTools/GitVersion/master/docs/img/README.png

build.cake

@@ -14,6 +14,7 @@ bool IsTagged = (BuildSystem.AppVeyor.Environment.Repository.Tag.IsTag &&
                 !string.IsNullOrWhiteSpace(BuildSystem.AppVeyor.Environment.Repository.Tag.Name));
 bool IsMainGitVersionRepo = StringComparer.OrdinalIgnoreCase.Equals("gittools/gitversion", BuildSystem.AppVeyor.Environment.Repository.Name);
 bool IsPullRequest = BuildSystem.AppVeyor.Environment.PullRequest.IsPullRequest;
+bool IsMainGitVersionBranch = StringComparer.OrdinalIgnoreCase.Equals("master", BuildSystem.AppVeyor.Environment.Repository.Branch);
 
 void Build(string configuration, string nugetVersion, string semVersion, string version, string preReleaseTag)
 {
@@ -120,6 +121,7 @@ Task("Zip-Files")
 
 Task("Create-Release-Notes")
     .IsDependentOn("Build")
+    .WithCriteria(() => IsMainGitVersionRepo && IsMainGitVersionBranch && !IsPullRequest)
     .Does(() =>
 {
 	var githubToken = EnvironmentVariable("GitHubToken");
@@ -160,8 +162,7 @@ Task("Upload-AppVeyor-Artifacts")
         "NuGetTaskBuild:GitVersionTask." + nugetVersion +".nupkg",
         "GitVersionTfsTaskBuild:gittools.gitversion-" + semVersion +".vsix",
         "GemBuild:" + gem,
-        "zip:GitVersion_" + nugetVersion + ".zip",
-        "releaseNotes:releasenotes.md"
+        "zip:GitVersion_" + nugetVersion + ".zip"
     });
 
     AppVeyor.UploadArtifact("build/NuGetExeBuild/GitVersion.Portable." + nugetVersion +".nupkg");
@@ -171,8 +172,15 @@ Task("Upload-AppVeyor-Artifacts")
     AppVeyor.UploadArtifact("build/GitVersionTfsTaskBuild/gittools.gitversion-" + semVersion + ".vsix");
     AppVeyor.UploadArtifact("build/GitVersion_" + nugetVersion + ".zip");
     AppVeyor.UploadArtifact("build/GemBuild/" + gem);
-    AppVeyor.UploadArtifact("build/releasenotes.md");
     AppVeyor.UploadArtifact("build/artifacts");
+
+    if(IsMainGitVersionRepo && IsMainGitVersionBranch && !IsPullRequest)
+    {
+        if(FileExists("build/releasenotes.md"))
+        {
+            AppVeyor.UploadArtifact("build/releasenotes.md");
+        }
+    }
 });
 
 

docs/configuration.md

@@ -1,4 +1,4 @@
-# Configuration
+# Configuration
 GitVersion 3.0 is mainly powered by configuration and no longer has branching
 strategies hard coded.
 
@@ -32,6 +32,7 @@ next-version: 1.0
 assembly-versioning-scheme: MajorMinorPatch
 assembly-informational-format: '{InformationalVersion}'
 mode: ContinuousDelivery
+increment: Inherit
 continuous-delivery-fallback-tag: ci
 tag-prefix: '[vV]'
 major-version-bump-message: '\+semver:\s?(breaking|major)'
@@ -70,6 +71,11 @@ value of the `AssemblyInformationalVersion` attribute. Default set to
 Sets the `mode` of how GitVersion should create a new version. Read more at
 [versioning mode](/reference/versioning-mode.md).
 
+### increment
+The part of the SemVer to increment when GitVersion detects it needs to be increased, such as for commits after a tag: `Major`, `Minor`, `Patch`, `None`.
+
+The special value `Inherit` means that GitVersion should find the parent branch (i.e. the branch where the current branch was branched from), and use its values for [increment](#increment), [prevent-increment-of-merged-branch-version](#prevent-increment-of-merged-branch-version) and [is-develop](#is-develop).
+
 ### continuous-delivery-fallback-tag
 When using `mode: ContinuousDeployment`, the value specified in
 `continuous-delivery-fallback-tag` will be used as the pre-release tag for
@@ -163,7 +169,7 @@ branches:
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
-    is-develop: false
+    tracks-release-branches: false
     is-release-branch: false
   release:
     regex: releases?[/-]
@@ -172,7 +178,7 @@ branches:
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
-    is-develop: false
+    tracks-release-branches: false
     is-release-branch: true
   feature:
     regex: features?[/-]
@@ -181,7 +187,7 @@ branches:
     increment: Inherit
     prevent-increment-of-merged-branch-version: false
     track-merge-target: false
-    is-develop: false
+    tracks-release-branches: false
     is-release-branch: false
   pull-request:
     regex: (pull|pull\-requests|pr)[/-]
@@ -191,7 +197,7 @@ branches:
     prevent-increment-of-merged-branch-version: false
     tag-number-pattern: '[/-](?<number>\d+)[-/]'
     track-merge-target: false
-    is-develop: false
+    tracks-release-branches: false
     is-release-branch: false
   hotfix:
     regex: hotfix(es)?[/-]
@@ -200,7 +206,7 @@ branches:
     increment: Patch
     prevent-increment-of-merged-branch-version: false
     track-merge-target: false
-    is-develop: false
+    tracks-release-branches: false
     is-release-branch: false
   support:
     regex: support[/-]
@@ -209,7 +215,7 @@ branches:
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
-    is-develop: false
+    tracks-release-branches: false
     is-release-branch: false
   develop:
     regex: dev(elop)?(ment)?$
@@ -218,7 +224,7 @@ branches:
     increment: Minor
     prevent-increment-of-merged-branch-version: false
     track-merge-target: true
-    is-develop: true
+    tracks-release-branches: true
     is-release-branch: false
 ```
 
@@ -246,8 +252,7 @@ of `alpha.foo` with the value of `alpha.{BranchName}`.
 **Note:** To clear a default use an empty string: `tag: ''`
 
 ### increment
-The part of the SemVer to increment when GitVersion detects it needs to be (i.e
-commit after a tag)
+Same as for the [global configuration, explained above](#increment).
 
 ### prevent-increment-of-merged-branch-version
 When `release-2.0.0` is merged into master, we want master to build `2.0.0`. If
@@ -282,11 +287,11 @@ Strategy which will look for tagged merge commits directly off the current
 branch. For example `develop` → `release/1.0.0` → merge into `master` and tag
 `1.0.0`. The tag is *not* on develop, but develop should be version `1.0.0` now.
 
-### is-develop
+### tracks-release-branches
 Indicates this branch config represents develop in GitFlow.
 
 ### is-release-branch
 Indicates this branch config represents a release branch in GitFlow.
 
 ### is-mainline
-When using Mainline mode, this indicates that this branch is a mainline. By default support/ and master are mainlines.
+When using Mainline mode, this indicates that this branch is a mainline. By default support/ and master are mainlines.

docs/index.md

@@ -3,6 +3,13 @@ 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!
 
+## Compatibility
+GitVersion works on Mac, Linux with Mono and Windows.
+
+Tip: If you get `System.TypeInitializationException: The type initializer for 'LibGit2Sharp.Core.NativeMethods' threw an exception. ---> System.DllNotFoundException: lib/linux/x86_64/libgit2-baa87df.so`
+
+You likely need to install `libcurl3`. Run `sudo get-get install libcurl3`
+
 ## Assumptions/Rules
 ### 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.

docs/more-info/version-sources.md

@@ -1,5 +1,5 @@
 # Version Sources
-GitVersion has a two step process for calculating the version number, the first is to calculate the base version which is used to then calculate what the next version should be.
+GitVersion has a two step process for calculating the version number. First it calculates the base version, which is then used to calculate what the next version should be.
 
 The logic of GitVersion is something like this:
 
@@ -8,26 +8,38 @@ The logic of GitVersion is something like this:
    - No: continue
  - Calculate the base version (highest version from all the sources)
  - Increment version if needed based on branch config
- - Calculate the build metadata (everything after the +) and append to the calcuated version
+ - Calculate the build metadata (everything after the +) and append to the calculated version
 
 ## Version Sources
-### Highest Accessible Tag
-GitVersion will find all tags on the current branch and return the highest one.
+### Tag name
+Returns the version numbers extracted from the current branch's tags.
 
 Will increment: true
 
 ### Version in branch name
-If the branch has a version in it, then that version will be returned.
+Returns the version number from the branch's name.
 
 Will increment: false
 
 ### Merge message
-If a branch with a version number in it is merged into the current branch, that version number will be used.
+Returns the version number of any branch (with a version number in its name) merged into the current branch.
 
-Will increment: false
+Will increment: depends on the value of `prevent-increment-of-merged-branch-version`
 
 ### GitVersion.yml
-If the `next-version` property is specified in the config file, it will be used as a version source.
+Returns the value of the `next-version` property in the config file.
+
+Will increment: false
+
+### Develop branch
+For the develop branch, i.e. marked with `is-develop: true`
+- Returns the version number extracted from any child release-branches, i.e. those marked with `is-release-branch: true`
+- Returns the version number of any tags on the master branch
+
+Will increment: true 
+
+### Fallback
+Returns the version number `0.1.0`.
 
 Will increment: false
 

docs/usage/command-line.md

@@ -64,4 +64,7 @@ At the moment only `tag-prefix` option is supported. Read more about [Configurat
 It will not change config file 'GitVersion.yml'.
 
 ### Example: How to override configuration option 'tag-prefix' to use prefix 'custom'
-`GitVersion.exe /output json /overrideconfig tag-prefix=custom`
+`GitVersion.exe /output json /overrideconfig tag-prefix=custom`
+
+## Mono
+To use on mac or linux, install `mono-complete` then just run `mono GitVersion.exe`

docs/who.md

@@ -8,5 +8,8 @@ Various people are actively using GitVersion, and taking advantage of the automa
  * [Orchestra](https://github.com/wildgums/orchestra)
  * [Pomona](http://pomona.io/)
  * [Shouldly](https://github.com/shouldly/shouldly)
+ * [Akavache](https://github.com/akavache/akavache)
+ * [Splat](https://github.com/paulcbetts/splat)
+ * [ReactiveUI](https://github.com/reactiveui/reactiveui)
 
 If you are using GitVersion in your projects, and you are not listed above, please feel free to add a link to your project.

src/GitVersionCore.Tests/BuildServers/GitLabCiMessageGenerationTest.cs

@@ -5,6 +5,7 @@
 using GitVersionCore.Tests;
 using NUnit.Framework;
 using Shouldly;
+using System.Reflection;
 
 [TestFixture]
 public class GitLabCiMessageGenerationTests
@@ -29,8 +30,8 @@ public void GenerateMessageTest()
     [Test]
     public void WriteAllVariablesToTheTextWriter()
     {
-        // this test method writes to disc, hence marked explicit
-        var f = "this_file_should_be_deleted.properties";
+        var assemblyLocation = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
+        var f = Path.Combine(assemblyLocation, "this_file_should_be_deleted.properties");
 
         try
         {