Merge pull request #484 from github/fixes/Nerdbank.GitVersioning

jcansdale · web-flow · commit c603aa9dab52 · 2019-10-18T10:38:15.000+01:00
Handle versioning using Nerdbank.GitVersioning
diff --git a/Directory.Build.Props b/Directory.Build.Props
@@ -5,4 +5,10 @@
     <Copyright>Copyright © GitHub, Inc. 2014-2018</Copyright>
     <LangVersion>7.3</LangVersion>
   </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="Nerdbank.GitVersioning">
+      <Version>3.0.26</Version>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
 </Project>
diff --git a/GitHubVS.sln b/GitHubVS.sln
@@ -14,6 +14,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Meta", "Meta", "{72036B62-2
 	ProjectSection(SolutionItems) = preProject
 		.editorconfig = .editorconfig
 		README.md = README.md
+		version.json = version.json
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GitHub.UI", "src\GitHub.UI\GitHub.UI.csproj", "{346384DD-2445-4A28-AF22-B45F3957BD89}"
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -40,21 +40,22 @@ jobs:
 
   # Instead run nuget manually.
 
+  - task: DotNetCoreCLI@2  
+    inputs:
+      command: custom
+      custom: tool
+      arguments: install --tool-path . nbgv
+    displayName: Install NBGV tool
+
+  - script: nbgv cloud
+    displayName: Set the cloud build number
+
   - script: tools\nuget\nuget.exe restore $(githubvsSolution)
     displayName: NuGet restore $(githubvsSolution)
 
   - script: tools\nuget\nuget.exe restore $(essentialsSolution)
     displayName: NuGet restore $(essentialsSolution)
 
-  # Ideally we'd run NerdBank.GitVersioning but that will come later. For now bump the
-  # version with the azure BuildId
-  - task: PowerShell@2
-    displayName: Bump version
-    inputs:
-      targetType: filePath
-      filePath: '$(Build.SourcesDirectory)\scripts\Bump-Version.ps1'
-      arguments: -BumpBuild -BuildNumber:$(Build.BuildId)
-
   - pwsh: mkdir $(ArtifactDirectory) -Force
     displayName: Create VSIX staging directory
 
diff --git a/src/GitHub.Exports/ExtensionInformation.cs b/src/GitHub.Exports/ExtensionInformation.cs
@@ -0,0 +1,9 @@
+﻿namespace GitHub
+{
+    public static class ExtensionInformation
+    {
+        // HACK: For some reason ThisAssembly.AssemblyFileVersion can't be referenced
+        // directly from inside GitHub.VisualStudio.
+        public const string Version = ThisAssembly.AssemblyFileVersion;
+    }
+}
diff --git a/src/GitHub.VisualStudio.16/source.extension.vsixmanifest b/src/GitHub.VisualStudio.16/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
   <Metadata>
-    <Identity Id="f4fbb70d-dee2-4dee-b322-bd74e3010e8f" Version="2.10.8.0" Language="en-US" Publisher="GitHub, Inc" />
+    <Identity Id="f4fbb70d-dee2-4dee-b322-bd74e3010e8f" Version="|%CurrentProject%;GetBuildVersion|" Language="en-US" Publisher="GitHub, Inc" />
     <DisplayName>GitHub Essentials</DisplayName>
     <Description>Clone or checkout code from GitHub</Description>
     <PackageId>GitHub.VisualStudio.16</PackageId>
diff --git a/src/GitHub.VisualStudio.Vsix/GitHub.VisualStudio.Vsix.csproj b/src/GitHub.VisualStudio.Vsix/GitHub.VisualStudio.Vsix.csproj
@@ -357,7 +357,6 @@
   <Import Project="packaging.targets" />
   <!-- For regenerating templates on build -->
   <Import Project="..\common\t4.targets" />
-  <Import Project="versioning.targets" />
   <!--
     This is a workaround for allowing neutral CTO resource produced from *.vsct to go in the main assembly.
     We move the neutral *.cto file to be categorized as WithCulture=true,Culture=en to prevent the tools from falsely reporting:
diff --git a/src/GitHub.VisualStudio.Vsix/source.extension.vsixmanifest b/src/GitHub.VisualStudio.Vsix/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
   <Metadata>
-    <Identity Id="c3d3dc68-c977-411f-b3e8-03b0dccf7dfc" Version="2.10.8.0" Language="en-US" Publisher="GitHub, Inc" />
+    <Identity Id="c3d3dc68-c977-411f-b3e8-03b0dccf7dfc" Version="|%CurrentProject%;GetBuildVersion|" Language="en-US" Publisher="GitHub, Inc" />
     <DisplayName>GitHub Extension for Visual Studio</DisplayName>
     <Description xml:space="preserve">A Visual Studio Extension that brings the GitHub Flow into Visual Studio.</Description>
     <PackageId>GitHub.VisualStudio</PackageId>
diff --git a/src/GitHub.VisualStudio.Vsix/versioning.targets b/src/GitHub.VisualStudio.Vsix/versioning.targets
diff --git a/src/GitHub.VisualStudio/GitHub.VisualStudio.csproj b/src/GitHub.VisualStudio/GitHub.VisualStudio.csproj
@@ -170,7 +170,6 @@
     <None Include="..\common\settings.json">
       <Link>Properties\settings.json</Link>
     </None>
-    <None Include="..\..\build\version" />
   </ItemGroup>
   <ItemGroup>
     <VSCTCompile Include="GitHub.VisualStudio.vsct">
@@ -318,7 +317,6 @@
   <Import Project="packaging.targets" />
   <!-- For regenerating templates on build -->
   <Import Project="..\common\t4.targets" />
-  <Import Project="versioning.targets" />
   <!--
     This is a workaround for allowing neutral CTO resource produced from *.vsct to go in the main assembly.
     We move the neutral *.cto file to be categorized as WithCulture=true,Culture=en to prevent the tools from falsely reporting:
diff --git a/src/GitHub.VisualStudio/GitHubPackage.cs b/src/GitHub.VisualStudio/GitHubPackage.cs
@@ -35,7 +35,7 @@
 namespace GitHub.VisualStudio
 {
     [PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]
-    [InstalledProductRegistration("#110", "#112", AssemblyVersionInformation.Version)]
+    [InstalledProductRegistration("#110", "#112", ExtensionInformation.Version)]
     [Guid(Guids.guidGitHubPkgString)]
     [ProvideMenuResource("Menus.ctmenu", 1)]
     [ProvideAutoLoad(Guids.GitContextPkgString, PackageAutoLoadFlags.BackgroundLoad)]
diff --git a/src/GitHub.VisualStudio/Services/UsageTracker.cs b/src/GitHub.VisualStudio/Services/UsageTracker.cs
@@ -171,7 +171,7 @@ async Task<UsageModel> GetCurrentReport(UsageData data)
             current.Dimensions.Lang = CultureInfo.InstalledUICulture.IetfLanguageTag;
             current.Dimensions.CurrentLang = CultureInfo.CurrentCulture.IetfLanguageTag;
             current.Dimensions.CurrentUILang = CultureInfo.CurrentUICulture.IetfLanguageTag;
-            current.Dimensions.AppVersion = AssemblyVersionInformation.Version;
+            current.Dimensions.AppVersion = ExtensionInformation.Version;
             current.Dimensions.VSVersion = vsservices.VSVersion;
 
             current.Dimensions.IsGitHubUser = IsGitHubUser;
diff --git a/src/GitHub.VisualStudio/Services/VisualStudioUsageTracker.cs b/src/GitHub.VisualStudio/Services/VisualStudioUsageTracker.cs
@@ -49,7 +49,7 @@ void LogTelemetryEvent(string counterName)
             var operation = new TelemetryEvent(Event.UsageTracker);
             operation.Properties[Property.TelemetryVersion] = TelemetryVersion;
             operation.Properties[Property.CounterName] = counterName;
-            operation.Properties[Property.ExtensionVersion] = AssemblyVersionInformation.Version;
+            operation.Properties[Property.ExtensionVersion] = ExtensionInformation.Version;
             operation.Properties[Property.IsGitHubUser] = IsGitHubUser;
             operation.Properties[Property.IsEnterpriseUser] = IsEnterpriseUser;
 
diff --git a/src/GitHub.VisualStudio/versioning.targets b/src/GitHub.VisualStudio/versioning.targets
diff --git a/src/common/SolutionInfo.cs b/src/common/SolutionInfo.cs
@@ -1,23 +1,12 @@
-using System;
 using System.Reflection;
 using System.Resources;
 using System.Runtime.InteropServices;
 
 [assembly: AssemblyProduct("GitHub Extension for Visual Studio")]
-[assembly: AssemblyVersion(AssemblyVersionInformation.Version)]
-[assembly: AssemblyFileVersion(AssemblyVersionInformation.Version)]
-[assembly: AssemblyInformationalVersion(AssemblyVersionInformation.Version)]
 [assembly: ComVisible(false)]
 [assembly: AssemblyCompany("GitHub, Inc.")]
-[assembly: AssemblyCopyright("Copyright � GitHub, Inc. 2014-2016")]
+[assembly: AssemblyCopyright("Copyright � GitHub, Inc. 2014-2019")]
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 [assembly: NeutralResourcesLanguage("en-US")]
-
-namespace System
-{
-    internal static class AssemblyVersionInformation {
-        internal const string Version = "2.10.8.0";
-    }
-}
diff --git a/test/MetricsTests/MetricsServer/Properties/AssemblyInfo.cs b/test/MetricsTests/MetricsServer/Properties/AssemblyInfo.cs
@@ -18,19 +18,3 @@
 // to COM components.  If you need to access a type in this assembly from
 // COM, set the ComVisible attribute to true on that type.
 [assembly: ComVisible(false)]
-
-// The following GUID is for the ID of the typelib if this project is exposed to COM
-[assembly: Guid("14fdee91-7301-4247-846c-049647bf8e99")]
-
-// Version information for an assembly consists of the following four values:
-//
-//      Major Version
-//      Minor Version
-//      Build Number
-//      Revision
-//
-// You can specify all the values or you can default the Build and Revision Numbers
-// by using the '*' as shown below:
-// [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
diff --git a/test/MetricsTests/MetricsTests/Properties/AssemblyInfo.cs b/test/MetricsTests/MetricsTests/Properties/AssemblyInfo.cs
@@ -18,19 +18,3 @@
 // to COM components.  If you need to access a type in this assembly from
 // COM, set the ComVisible attribute to true on that type.
 [assembly: ComVisible(false)]
-
-// The following GUID is for the ID of the typelib if this project is exposed to COM
-[assembly: Guid("09313e65-7adb-48c1-ad3a-572020c5bdcb")]
-
-// Version information for an assembly consists of the following four values:
-//
-//      Major Version
-//      Minor Version
-//      Build Number
-//      Revision
-//
-// You can specify all the values or you can default the Build and Revision Numbers
-// by using the '*' as shown below:
-// [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
diff --git a/version.json b/version.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
+  "version": "2.11",
+  "publicReleaseRefSpec": [
+    "^refs/heads/master$",
+    "^refs/heads/v\\d+(?:\\.\\d+)?$"
+  ],
+  "assemblyVersion": {
+    "precision": "revision"
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@`
`35`	`35`	`namespace GitHub.VisualStudio`
`36`	`36`	`{`
`37`	`37`	`[PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]`
`38`		`- [InstalledProductRegistration("#110", "#112", AssemblyVersionInformation.Version)]`
	`38`	`+ [InstalledProductRegistration("#110", "#112", ExtensionInformation.Version)]`
`39`	`39`	`[Guid(Guids.guidGitHubPkgString)]`
`40`	`40`	`[ProvideMenuResource("Menus.ctmenu", 1)]`
`41`	`41`	`[ProvideAutoLoad(Guids.GitContextPkgString, PackageAutoLoadFlags.BackgroundLoad)]`