Merge origin/master into fixLinuxMono

Author: AArnott

CONTRIBUTING.md

@@ -0,0 +1,111 @@
+Contributing to this project
+============================
+
+## Prerequisites
+
+This project is actively developed using the following software.
+It is highly recommended that anyone contributing to this library use the same
+software.
+
+1. [Visual Studio 2015][VS]
+2. [Node.js][NodeJs]
+
+### Optional additional software
+
+Some projects in the Visual Studio solution require optional or 3rd party components to open.
+They are not required to build the full solution from the command line using MSBuild,
+but installing this software will facilitate an enhanced developer experience in Visual Studio.
+
+1. [Node.js Tools for Visual Studio][NodeJsTools]
+2. [NuProj for VS2015][NuProj]
+
+All other dependencies are acquired via NuGet or NPM.
+
+## Building
+
+To build this repository from the command line, you must first execute our init.ps1 script,
+which downloads NuGet.exe and uses it to restore packages.
+Assuming your working directory is the root directory of this git repo,
+and you are running Windows PowerShell, the command is:
+
+    .\init.ps1
+
+Everything in the repo may be built via building the solution file
+either from Visual Studio 2015 or the VS2015 Developer Command Prompt:
+
+    .\build.ps1
+
+This repo is structured such that it builds the NuGet package first, using MSBuild.
+It then builds an NPM package that includes some of the outputs of MSBuild, along with
+some javascript, for our NPM consumers who want a reasonable versioning story for their
+NPM packages too.
+
+### Important notice when developing with Visual Studio
+
+The NuGet package restore functionality in Visual Studio does not work for this project, which relies
+on newer functionality than comes with Visual Studio 2015 Update 3. You should disable automatic
+package restore on build in Visual Studio in order to build successfully and have a useful Error List
+while developing.
+
+Follow these steps to disable automatic package restore in Visual Studio:
+
+1. Tools -> Options -> NuGet Package Manager -> General
+2. *Clear* the checkbox for "Automatically check for missing packages during build in Visual Studio
+
+With this setting, you can still execute a package restore within Visual Studio by right-clicking
+on the _solution_ node in Solution Explorer and clicking "Restore NuGet Packages". But do not ever
+execute that on this project as that will corrupt the result of `init.ps1`.
+
+Before developing this project in Visual Studio, or after making project or project.json changes,
+or to recover after Visual Studio executes a package restore, run the `init` script again.
+
+## Testing
+
+The Visual Studio 2015 Test Explorer will list and execute all tests.
+
+## Pull requests
+
+Pull requests are welcome! They may contain additional test cases (e.g. to demonstrate a failure),
+and/or product changes (with bug fixes or features). All product changes should be accompanied by
+additional tests to cover and justify the product change unless the product change is strictly an
+efficiency improvement and no outwardly observable change is expected.
+
+In the master branch, all tests should always pass. Added tests that fail should be marked as Skip
+via `[Fact(Skip = "Test does not pass yet")]` or similar message to keep our test pass rate at 100%.
+
+## Self-service releases for contributors
+
+As soon as you send a pull request, a build is executed and updated NuGet packages
+are published to this Package Feed:
+
+    https://ci.appveyor.com/nuget/nerdbank-gitversioning
+
+By adding this URL to your package sources you can immediately install your version
+of the NuGet packages to your project. This can be done by adding a nuget.config file
+with the following content to the root of your project's repo:
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+    <packageSources>
+        <add key="Nerdbank.GitVersioning CI" value="https://ci.appveyor.com/nuget/nerdbank-gitversioning" />
+    </packageSources>
+</configuration>
+```
+
+You can then install the package(s) while you have your new "Nerdbank.GitVersioning CI" package source selected:
+
+```powershell
+Install-Package Nerdbank.GitVersioning -Pre -Version 0.1.41-g02f355c05d
+```
+
+Take care to set the package version such that it exactly matches the AppVeyor build
+for your pull request. You can get the version number by reviewing the result of the
+validation build for your pull request, clicking ARTIFACTS, and noting the version
+of the produced packages.
+
+ [VS]: https://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs.aspx
+ [NodeJs]: https://nodejs.org
+ [NuProj]: https://onedrive.live.com/redir?resid=63D0C265F96E43D!2477835&authkey=!AHh2k9FoNR-nFHo&ithint=file%2cmsi
+ [NodeJsTools]: https://www.visualstudio.com/vs/node-js/
+ [NuGetClient]: https://dist.nuget.org/win-x86-commandline/v3.3.0/nuget.exe

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Microsoft Corporation
+Copyright (c) Andrew Arnott
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

appveyor.yml

@@ -15,8 +15,6 @@ environment:
     secure: Ql19CstT9GvFNeSIAjXvgHXZg+/pNaYJ2jVkzde4LT2vwSyjiQgQ+M332wVYtu+r
 install:
 - ps: >-
-    iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/install-nuget-3-3-0.ps1'))
-
     npm install npm -g
 before_build:
 - ps: >-

build.cmd

@@ -0,0 +1 @@
+powershell.exe -ExecutionPolicy bypass -Command "& '%~dpn0.ps1'" %*

build.ps1

@@ -8,10 +8,14 @@ The project configuration to build.
 Param(
     [Parameter()]
     [ValidateSet('Debug', 'Release')]
-    [string]$Configuration
+    [string]$Configuration,
+
+    [Parameter()]
+    [ValidateSet('minimal', 'normal', 'detailed', 'diagnostic')]
+    [string]$MsBuildVerbosity = 'minimal'
 )
 
-$msbuildCommandLine = "msbuild `"$PSScriptRoot\src\Nerdbank.GitVersioning.sln`" /m /verbosity:minimal /nologo"
+$msbuildCommandLine = "msbuild `"$PSScriptRoot\src\Nerdbank.GitVersioning.sln`" /m /verbosity:$MsBuildVerbosity /nologo /p:Platform=`"Any CPU`""
 
 if (Test-Path "C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll") {
     $msbuildCommandLine += " /logger:`"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll`""

doc/node.md

@@ -8,7 +8,7 @@ See [NPM acquisition](npm-acquisition.md).
 
 ```js
 var nbgv = require('nerdbank-gitversioning')
-nbgv.getGitVersion()
+nbgv.getVersion()
     .then(r => console.log(r))
     .catch(e => console.error(e));
 ```

init.cmd

@@ -0,0 +1 @@
+powershell.exe -ExecutionPolicy bypass -NoProfile -Command "& '%~dpn0.ps1'" %*

init.ps1

@@ -6,28 +6,41 @@ Restores all NuGet, NPM and Typings packages necessary to build this repository.
 Param(
 )
 
-Write-Host "Restoring NuGet packages..." -ForegroundColor Yellow
+$oldPlatform=$env:Platform
+$env:Platform='AnyCPU' # Some people wander in here from a platform-specific build window.
 
-# First restore NuProj packages since the solution restore depends on NuProj evaluation succeeding.
-gci "$PSScriptRoot\src\project.json" -rec |? { $_.FullName -imatch 'nuget' } |% {
-    if ($PSCmdlet.ShouldProcess($_, "nuget restore")) {
-        nuget restore $_ -Verbosity quiet
+Push-Location $PSScriptRoot
+try {
+    $toolsPath = "$PSScriptRoot\tools"
+
+    # First restore NuProj packages since the solution restore depends on NuProj evaluation succeeding.
+    gci "$PSScriptRoot\src\project.json" -rec |? { $_.FullName -imatch 'nuget' } |% {
+        & "$toolsPath\Restore-NuGetPackages.ps1" -Path $_ -Verbosity Quiet
     }
-}
 
-if ($PSCmdlet.ShouldProcess("$PSScriptRoot\src", "nuget restore")) {
-    nuget restore "$PSScriptRoot\src" -Verbosity quiet
-}
+    # Restore VS solution dependencies
+    gci "$PSScriptRoot\src" -rec |? { $_.FullName.EndsWith('.sln') } |% {
+        & "$toolsPath\Restore-NuGetPackages.ps1" -Path $_.FullName -Verbosity Quiet
+    }
 
-Write-Host "Restoring NPM packages..." -ForegroundColor Yellow
-Push-Location "$PSScriptRoot\src\nerdbank-gitversioning.npm"
-if ($PSCmdlet.ShouldProcess("$PSScriptRoot\src\nerdbank-gitversioning.npm", "npm install")) {
-    npm install --loglevel error
-}
+    Write-Host "Restoring NPM packages..." -ForegroundColor Yellow
+    Push-Location "$PSScriptRoot\src\nerdbank-gitversioning.npm"
+    if ($PSCmdlet.ShouldProcess("$PSScriptRoot\src\nerdbank-gitversioning.npm", "npm install")) {
+        npm install --loglevel error
+    }
 
-Write-Host "Restoring Typings..." -ForegroundColor Yellow
-if ($PSCmdlet.ShouldProcess("$PSScriptRoot\src\nerdbank-gitversioning.npm", "typings install")) {
-    .\node_modules\.bin\typings install
-}
+    Write-Host "Restoring Typings..." -ForegroundColor Yellow
+    if ($PSCmdlet.ShouldProcess("$PSScriptRoot\src\nerdbank-gitversioning.npm", "typings install")) {
+        .\node_modules\.bin\typings install
+    }
 
-Pop-Location
+    Write-Host "Successfully restored all dependencies" -ForegroundColor Yellow
+}
+catch {
+    Write-Error "Aborting script due to error"
+    exit $lastexitcode
+}
+finally {
+    $env:Platform=$oldPlatform
+    Pop-Location
+}

readme.md

@@ -70,12 +70,14 @@ When built as a public release, the git commit ID is dropped:
 
 ### What is 'git height'?
 
-Git 'height' is the count of commits in the longest path between HEAD (the code you're building)
-and some origin point. In this case the origin is the commit that set the major.minor version number
-to the values found in HEAD.
+Git 'height' is the number of commits in the longest path from HEAD (the code you're building)
+to some origin point, inclusive. In this case the origin is the commit that set the major.minor
+version number to the values found in HEAD.
 
 For example, if the version specified at HEAD is 3.4 and the longest path in git history from HEAD
-to where the version file was changed to 3.4 is 15 steps, then the git height is "15".
+to where the version file was changed to 3.4 includes 15 commits, then the git height is "15".
+Another example is when HEAD points directly at the commit that changed the major.minor version,
+which has a git height of 1. [Learn more about 1 being the minimum revision number][GitHeightMinimum].
 
 ### Why is the git height used for the PATCH version component for public releases?
 
@@ -110,4 +112,10 @@ that can help you to translate between the two representations.
 `Get-CommitId.ps1` takes a version and print out the matching commit (or possible commits, in the exceptionally rare event of a collision).
 `Get-Version.ps1` prints out the version information for the git commit current at HEAD.
 
+### How do I build Nerdbank.GitVersioning from source?
+
+Prerequisites and build instructions are found in our
+[contributing guidelines](CONTRIBUTING.md).
+
  [semver]: http://semver.org
+ [GitHeightMinimum]: https://github.com/AArnott/Nerdbank.GitVersioning/issues/102#issuecomment-269591960

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -98,6 +98,22 @@ public async Task GetBuildVersion_Without_Git()
         Assert.Equal("3.4.0", buildResult.AssemblyInformationalVersion);
     }
 
+    [Fact]
+    public async Task GetBuildVersion_Without_Git_HighPrecisionAssemblyVersion()
+    {
+        this.WriteVersionFile(new VersionOptions
+        {
+            Version = SemanticVersion.Parse("3.4"),
+            AssemblyVersion = new VersionOptions.AssemblyVersionOptions
+            {
+                Precision = VersionOptions.VersionPrecision.Revision,
+            },
+        });
+        var buildResult = await this.BuildAsync();
+        Assert.Equal("3.4", buildResult.BuildVersion);
+        Assert.Equal("3.4.0", buildResult.AssemblyInformationalVersion);
+    }
+
     [Fact]
     public async Task GetBuildVersion_OutsideGit_PointingToGit()
     {
@@ -295,6 +311,7 @@ public async Task GetBuildVersion_CustomAssemblyVersion()
     }
 
     [Theory]
+    [InlineData(VersionOptions.VersionPrecision.Major)]
     [InlineData(VersionOptions.VersionPrecision.Build)]
     [InlineData(VersionOptions.VersionPrecision.Revision)]
     public async Task GetBuildVersion_CustomAssemblyVersionWithPrecision(VersionOptions.VersionPrecision precision)
@@ -315,6 +332,7 @@ public async Task GetBuildVersion_CustomAssemblyVersionWithPrecision(VersionOpti
     }
 
     [Theory]
+    [InlineData(VersionOptions.VersionPrecision.Major)]
     [InlineData(VersionOptions.VersionPrecision.Build)]
     [InlineData(VersionOptions.VersionPrecision.Revision)]
     public async Task GetBuildVersion_CustomAssemblyVersionPrecision(VersionOptions.VersionPrecision precision)
@@ -348,6 +366,21 @@ public async Task GetBuildVersion_CustomBuildNumberOffset()
         this.AssertStandardProperties(versionOptions, buildResult);
     }
 
+    [Fact]
+    public async Task GetBuildVersion_Minus1BuildOffset_NotYetCommitted()
+    {
+        this.WriteVersionFile("14.0");
+        this.InitializeSourceControl();
+        var versionOptions = new VersionOptions
+        {
+            Version = new SemanticVersion(new Version(14, 1)),
+            BuildNumberOffset = -1,
+        };
+        VersionFile.SetVersion(this.RepoPath, versionOptions);
+        var buildResult = await this.BuildAsync();
+        this.AssertStandardProperties(versionOptions, buildResult);
+    }
+
     [Fact]
     public async Task PublicRelease_RegEx_Unsatisfied()
     {
@@ -370,7 +403,8 @@ public static IEnumerable<object[]> CloudBuildOfBranch(string branchName)
         return new object[][]
         {
             new object[] { CloudBuild.AppVeyor.SetItem("APPVEYOR_REPO_BRANCH", branchName) },
-            new object[] { CloudBuild.VSTS.SetItem( "BUILD_SOURCEBRANCH", $"refs/heads/{branchName}") },
+            new object[] { CloudBuild.VSTS.SetItem("BUILD_SOURCEBRANCH", $"refs/heads/{branchName}") },
+            new object[] { CloudBuild.VSTS.SetItem("BUILD_SOURCEBRANCH", branchName) }, // VSTS building a github repo
         };
     }
 
@@ -718,11 +752,15 @@ public async Task AssemblyInfo_SuppressedImplicitlyByTargetExt()
 
     private static Version GetExpectedAssemblyVersion(VersionOptions versionOptions, Version version)
     {
-        var assemblyVersionPrecision = versionOptions.AssemblyVersion?.Precision ?? VersionOptions.VersionPrecision.Minor;
-        int assemblyVersionBuild = assemblyVersionPrecision >= VersionOptions.VersionPrecision.Build ? version.Build : 0;
-        int assemblyVersionRevision = assemblyVersionPrecision >= VersionOptions.VersionPrecision.Revision ? version.Revision : 0;
-        Version assemblyVersion = (versionOptions.AssemblyVersion?.Version ?? versionOptions.Version.Version).EnsureNonNegativeComponents();
-        assemblyVersion = new Version(assemblyVersion.Major, assemblyVersion.Minor, assemblyVersionBuild, assemblyVersionRevision);
+        // Function should be very similar to VersionOracle.GetAssemblyVersion()
+        var assemblyVersion = (versionOptions?.AssemblyVersion?.Version ?? versionOptions.Version.Version).EnsureNonNegativeComponents();
+        var precision = versionOptions?.AssemblyVersion?.Precision ?? VersionOptions.DefaultVersionPrecision;
+
+        assemblyVersion = new System.Version(
+            assemblyVersion.Major,
+            precision >= VersionOptions.VersionPrecision.Minor ? assemblyVersion.Minor : 0,
+            precision >= VersionOptions.VersionPrecision.Build ? version.Build : 0,
+            precision >= VersionOptions.VersionPrecision.Revision ? version.Revision : 0);
         return assemblyVersion;
     }