Use Nerdbank.GitVersioning (#369)

- Calculate version number dynamically
- Support pushing prerelease versions on NuGet
- Reduce downstream maintenance efforts by fixing the version number to MAJOR.0.0.0
- Create GitHub releases for everything that's pushed to NuGet

Author: fgreinacher

.travis.yml

@@ -5,3 +5,5 @@ script:
   - dotnet build System.IO.Abstractions --framework netstandard1.4
   - dotnet build System.IO.Abstractions.TestingHelpers --framework netstandard1.4
   - dotnet test System.IO.Abstractions.TestingHelpers.Tests --framework netcoreapp2.0
+git:
+  depth: false

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributor guide
+
+## Versioning
+
+This library uses [Nerdbank.GitVersioning](https://github.com/AArnott/Nerdbank.GitVersioning) for generating stable and reproducible version numbers.
+
+The so-called base version is manually maintained in [the version config](version.json). Every build calculates its final version number based on the base version and the number of changes that occured since the last change to the version config.
+
+The base version represents the _next_ version that we will released. During development it contains a prerelease suffix, like `-beta` which is appended to the generated NuGet packages.
+
+Every successful commit on `master` deploys packages to `nuget.org` and a creates GitHub release. As long as we have the prelease suffix both will be marked as such.
+
+### Release workflow
+
+1. Remove prelease suffix from `version.json`.
+1. Wait for the completion of the deployment.
+1. Remove the prerelease flag from the newly created GitHub release.
+1. Increment the version number in `version.json` and again add the prelease suffix (usually `beta` is fine).

System.IO.Abstractions.TestingHelpers/System.IO.Abstractions.TestingHelpers.csproj

@@ -2,7 +2,6 @@
     <PropertyGroup>
         <TargetFrameworks>net40;netstandard1.4;netstandard2.0;</TargetFrameworks>
         <PackageId>System.IO.Abstractions.TestingHelpers</PackageId>
-        <Version>0.0.0.1</Version>
         <Description>A set of pre-built mocks to help when testing file system interactions.</Description>
         <Company />
         <Product>System.IO.Abstractions</Product>
@@ -36,4 +35,12 @@
         <PackageReference Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
         <PackageReference Include="System.Security.AccessControl" Version="4.5.0" />
     </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Nerdbank.GitVersioning" Version="2.2.13">
+        <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+        <PrivateAssets>all</PrivateAssets>
+      </PackageReference>
+    </ItemGroup>
+
 </Project>

System.IO.Abstractions/System.IO.Abstractions.csproj

@@ -2,7 +2,6 @@
 
     <PropertyGroup>
         <TargetFrameworks>net40;netstandard1.4;netstandard2.0;</TargetFrameworks>
-        <Version>0.0.0.1</Version>
         <Authors>Tatham Oddie</Authors>
         <Company />
         <Description>A set of abstractions to help make file system interactions testable.</Description>
@@ -11,7 +10,8 @@
         <PackageLicenseUrl>https://github.com/System-IO-Abstractions/System.IO.Abstractions/blob/master/LICENSE</PackageLicenseUrl>
         <PackageProjectUrl>https://github.com/System-IO-Abstractions/System.IO.Abstractions</PackageProjectUrl>
         <PackageTags>testing</PackageTags>
-		<GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <NoWarn>$(NoWarn);CS1591;CS1574</NoWarn>
     </PropertyGroup>
 
     <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
@@ -27,7 +27,7 @@
             <Version>4.5.0</Version>
         </PackageReference>
     </ItemGroup>
-  
+
     <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.4'">
         <PackageReference Include="System.IO.FileSystem.AccessControl">
             <Version>4.5.0</Version>
@@ -47,4 +47,12 @@
         <Reference Include="System" />
         <Reference Include="Microsoft.CSharp" />
     </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Nerdbank.GitVersioning" Version="2.2.13">
+        <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+        <PrivateAssets>all</PrivateAssets>
+      </PackageReference>
+    </ItemGroup>
+
 </Project>

appveyor.yml

@@ -9,17 +9,6 @@ branches:
   only:
     - master
 
-version: 2.1.0.{build}
-
-pull_requests:
-  do_not_increment_build_number: true
-
-dotnet_csproj:
-  patch: true
-  file: '**\*.csproj'
-  version: '{version}'
-  package_version: '{version}'
-
 environment:
   INHERITDOC_VERSION: 1.2.2.1
   TEMP_DIR: c:\temp
@@ -46,3 +35,14 @@ deploy:
   artifact: /.*\.nupkg/
   on:
     branch: master
+
+- provider: GitHub
+  tag: v$(GitBuildVersion)
+  prerelease: true
+  artifact: /.*\.nupkg/
+  auth_token:
+    secure: 4ejpp3dzvpOwfD7TOcypCsT0z8j+qYiihiZszS3uVI78vZpAtM+P+A8NK2JZmYMo
+  on: 
+    branch: master
+
+    

version.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
+    "version": "2.2-beta",
+    "assemblyVersion": {
+      "precision": "major"
+    },
+    "publicReleaseRefSpec": [
+      "^refs/heads/master$"
+    ],
+    "cloudBuild": {
+      "buildNumber": {
+        "enabled": true,
+        "setVersionVariables": true
+      }
+    }
+}