Inject into correct point in build pipeline for VS 2017

[clairernovotny]

This is an initial attempt at implementing the .NET Desktop side of #1118.

Notably, it's a bit "whack a mole" in terms of ensuring the GetVersion target is executed early enough. Then, without trying to overwrite what the user wants, the user will have to add something like this into their project file in order to copy the generated values into the correct version variables:

  <Target Name="UpdateVersionVars" AfterTargets="GetVersion">
    <PropertyGroup>
      <Version>$(GitVersion_SemVer)</Version>
      <PackageVersion>$(GitVersion_SemVer)</PackageVersion>
    </PropertyGroup>
  </Target>

Copying to Version at that stage will ensure that the AssemblyFileVersion and AssemblyVersion are set based on that Version turns into the informational version. I'm not sure if you can use the FullSemVer there or if that'll cause the parsing to barf.... either way, the user is in control of what variables they assign to what there.

If there's a better way to do this than to have the user supply an AfterTargets, then I'm all for it. I tested this locally and it did correctly generate the file/assembly versions and the package version when using the pack command.

[clairernovotny]

Related to this in terms of making it easier to extend the Version tag dotnet/sdk#504

[clairernovotny]

I've made a few updates:

1. Just works now by default in all projects. In "SDK" projects, UpdateAssemblyInfo gets defaulted to off and instead it'll set the appropriate MSBuild properties that other tasks use to generate the assembly info and nuget packaging. Of course, this can be turned off.
2. It can optionally use the full semver 2.0 in the nuget packaging. This is off by default since many servers don't yet support it (I believe the symbolsource stuff breaks currently). You can set <UseFullSemVerForNuGet>true</UseFullSemVerForNuGet> in your project file to opt-in to using SemVer 2.0 package versions.

[asbjornu]

@onovotny: Is this backwards compatible with VS2015?

[clairernovotny]

It should be, it adds a few properties that weren’t in or used before and takes an additional “or” dependency on a couple of targets that weren’t there before either.

…

Sent from my Windows 10 phone From: Asbjørn Ulsberg<mailto:notifications@github.com> Sent: Friday, December 30, 2016 3:09 PM To: GitTools/GitVersion<mailto:GitVersion@noreply.github.com> Cc: Oren Novotny<mailto:oren@novotny.org>; Mention<mailto:mention@noreply.github.com> Subject: Re: [GitTools/GitVersion] Inject into correct point in build pipeline for VS 2017 (#1119) @onovotny<https://github.com/onovotny>: Is this backwards compatible with VS2015? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#1119 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/ABXHVKepabBZ33J6-pcJnrlYKQ6KCEVqks5rNWTlgaJpZM4LNomU>.

[thoemmi]

Any news on this? I have a new VS2017 RC project cross-targeting net40 and net45:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFrameworks>net40;net45</TargetFrameworks>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="GitVersionTask" Version="4.0.0-beta0009" />
  </ItemGroup>
  <!-- ... -->

The compile failes because of duplicate Assembly*VersionAttributes.

1>obj\Debug\net40\StickyWindows.AssemblyInfo.cs(17,12,17,58): error CS0579: Duplicate 'System.Reflection.AssemblyFileVersionAttribute' attribute
1>obj\Debug\net40\StickyWindows.AssemblyInfo.cs(18,12,18,67): error CS0579: Duplicate 'System.Reflection.AssemblyInformationalVersionAttribute' attribute
1>obj\Debug\net40\StickyWindows.AssemblyInfo.cs(21,12,21,54): error CS0579: Duplicate 'System.Reflection.AssemblyVersionAttribute' attribute

[clairernovotny]

@thoemmi The fix to that is to remove those attributes from your AssemblyInfo file. That file is ideally completely generated now anyway by attributes in the csproj.

[thoemmi]

@onovotny Wisecracker 😉 Of course I already would have done that if there were an AssemblyInfo file.
It's a MSBuild "15" project, and there's no AssemblyInfo.cs.

Anyway, I think I can manage to create the correct version information. My current .csproj looks like this

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFrameworks>net40;net45</TargetFrameworks>

    <UpdateAssemblyInfo>false</UpdateAssemblyInfo>
    <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="GitVersionTask" Version="4.0.0-beta0009" />
  </ItemGroup>
  <Target Name="UpdateVersionVars" AfterTargets="GetVersion">
    <Message Text="$(GitVersion_SemVer)" Importance="High" />
    <PropertyGroup>
      <FileVersion>$(GitVersion_AssemblySemVer)</FileVersion>
      <AssemblyVersion>$(GitVersion_AssemblySemVer)</AssemblyVersion>
      <PackageVersion>$(GitVersion_SemVer)</PackageVersion>
      <InformationalVersion>$(GitVersion_SemVer)</InformationalVersion>
    </PropertyGroup>
  </Target>
  <!-- ... -->

The <UpdateAssemblyInfo>false</UpdateAssemblyInfo> says GitVersion ot to create an AssemblyInfo on its own. Instead, MSBuild uses a common set of properties: FileVersion, AssemblyVersion, PackageVersion, and InformationalVersion.
This works except PackageVersion: The generated Nupgk still uses the AssemblySemVer. I'll continue exploring MSBuild's .targets files, and post an update when I have found a solution.

[pascalberger]

@onovotny I've added two comments inline. Additionally it would be great if you can update the documentation here with the new properties and targets.

[pascalberger]

Remove multiple empty lines

[pascalberger]

Shouldn't the file NugetAssets\GitVersionTask.targets be deleted?

[clairernovotny]

it was moved into the build folder

[pascalberger]

Ah, missed this :)

[pascalberger]

Would be nice if these properties can be documented here

[clairernovotny]

will update the docs now

[clairernovotny]

I've added docs - I think I've covered it?

[pascalberger]

@onovotny Thanks LGTM. I'll merge it as soon as the build has passed.

[clairernovotny]

Once GitVersion supports CoreCLR and linux/mac, we can include a .net core version of these as well. I think LibGit2Sharp has that support now? I think NerdBank.GitVersioning is using that and he has a coreclr task.

[pascalberger]

@onovotny It's merged now. Thanks for your contribution!