dotnet / nerdbank.gitversioning Goto Github PK

We get the following build error intermittently when running a local build and consistently when using VSO's CI support:

##[error]packages\Nerdbank.GitVersioning.1.4.19\build\Nerdbank.GitVersioning.targets(40,7): Error MSB4064: The "BuildMetadata" parameter is not supported by the "GetBuildVersion" task. Verify the parameter exists on the task, and it is a settable public instance property.

When building locally, the error appears to correlate with cleaning the solution and/or rebuilding, as opposed to simply using incremental builds.

Thanks in advance.

We use Nerdbank.GitVersioning v 1.2.8. NuGet package, and while building our net46 project in VS 2015, there are some unexpected characters at the end of the generated *.Version.cs file, and the build fails with
Error CS1022 Type or namespace definition, or end-of-file expected ....Version.cs (28).

Here is the generated file with some fields in ThisAssembly class reduced to "..." for brevity, note the extra } at the end.

//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//     Runtime Version:4.0.30319.42000
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.150.919")]
[assembly: System.Reflection.AssemblyInformationalVersionAttribute("0.1.150-alpha+g970364a3df")]


internal sealed partial class ThisAssembly {
    internal const string AssemblyVersion = "0.1.0.0";
    internal const string AssemblyFileVersion = "0.1.150.919";
    internal const string AssemblyInformationalVersion = "0.1.150-alpha+g970364a3df";
    internal const string AssemblyName = "...";
    internal const string PublicKey = @"...";
    internal const string PublicKeyToken = "...";
    internal const string RootNamespace = "...";
    private ThisAssembly() {
    }
}

}

This is more of a PSA (Public Service Announcement) + workaround rather than a bug report.

With Appveyor you can configure builds to use "shallow clone" setting clone_depth: 1 to avoid transferring the whole repo history to the build machine.
http://www.appveyor.com/docs/how-to/repository-shallow-clone

However, Nerdbank.GitVersioning needs minimum of clone_depth=2 [or leave empty to have Appveyor clone the entire history] otherwise build fails with error from LibGit2Sharp:

error MSB4018: LibGit2Sharp.NotFoundException: Object not found - failed to find pack entry (.....) 

I have confirmed that changing clone_depth=1 to clone_depth=2 is sufficient to avoid this issue.

[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018: The "GetBuildVersion" task failed unexpectedly. [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018: LibGit2Sharp.NotFoundException: Object not found - failed to find pack entry (3f82961c75efd7cf324fdfe3703239512f0fb773) [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018:    at LibGit2Sharp.Core.Ensure.HandleError(Int32 result) [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018:    at LibGit2Sharp.Core.Proxy.git_revwalk_next(RevWalkerSafeHandle walker) [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018:    at LibGit2Sharp.CommitLog.CommitEnumerator.MoveNext() [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018:    at System.Linq.Enumerable.FirstOrDefault[TSource](IEnumerable`1 source) [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018:    at Nerdbank.GitVersioning.Tasks.GetBuildVersion.Execute() [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018:    at Microsoft.Build.BackEnd.TaskExecutionHost.Microsoft.Build.BackEnd.ITaskExecutionHost.Execute() [C:\projects\serverhost\ServerHost\ServerHost.csproj]
[00:00:08] C:\projects\serverhost\packages\Nerdbank.GitVersioning.1.4.30\build\Nerdbank.GitVersioning.targets(38,5): error MSB4018:    at Microsoft.Build.BackEnd.TaskBuilder.<ExecuteInstantiatedTask>d__26.MoveNext() [C:\projects\serverhost\ServerHost\ServerHost.csproj]

We need to generate a .h file for the ThisAssembly class, and an .rc file for the PE header version information.

Target CoreCLR with the MSBuild task and reference MSBuild Core assemblies.

Remaining work items:

• libgit2sharp needs to be a bit smarter about adding the native binaries directory to the PATH than just to use AppContext.BaseDirectory because that doesn't work for an MSBuild Task that uses it.
• figure out how to automate the build of a NuPkg with all the right files in place.
• Load the right MSBuild Tasks assembly based on whether MSBuild is running on .NET Fx or .NET Core
• Re-implement ThisAssembly code generation with Roslyn APIs
• Get tests running again (on both net45 and .NET Core)
• Get this building on appveyor
• Check that NPM package contains a nbgv.nuget folder that contains a subset of what is in the nupkg rather than a bunch of facade assemblies under build\msbuildcore

To work on Linux:

• Fix native libgit2 library loading in libgit2sharp (#112)

This fixes a usability quirk that a change to version.txt or version.json must be committed before the build will use the new version in the build.

Might be useful to have a way to set the build number the build server uses to match the calculated version.

I realize that all build servers have different ways to do this but it is possible:

• TeamCity
• AppVeyor
• VSTS Agents

To name a few popular ones

When building a stable nuget package, such that the version is, for example, 14.1.6, tracing that version back to a commit ID using:

tools\Get-CommitId.ps1 14.1.6

Fails to produce a commit ID.

Remove the need to manually create a version.txt file and update AssemblyInfo.cs after the NuGet package is installed. By leveraging NuGet's Install.ps1 script, we should be able to automate this process by seeding the version.txt file with the Major.Minor from the AssemblyVersion attribute in AssemblyInfo.cs.

The VSTS cloud builds have a Build.BuildNumber variable, as defined here.

Although NB.GV can set the build number, the Build.BuildNumber variable remains unchanged. Consider changing it explicitly within the build as well.

Reported by @jkeech

Fix in PR #9

The test in Create-VersionFile.ps1 for whether to create the version.json only checks the immediate project directory and not parent directories.

It should be modified to walk up the directories till the root, looking for the file. This is what the NB.GV build authoring itself does so the ps1 should behave the same way.

C# assemblyinfo is generated into VB projects. This causes compile time errors for the VB projects, obviously.

Is there anyway to improve the performance of the GetBuildVersion task?
In my case I've a solution with about 30 projects all in the same git repository and all of them get the same version in the end. The git repository is rather large, containing more than 20.000 commits. When doing a full rebuild each invocation of GetBuildVersion takes about one second summing up to a total of about half a minute additional build time. When doing an incremental build it's usually about 5 to 10 projects which are affected adding additional 5 to 10 seconds build time which kinda hurts.
Since all of these invocations of GetBuildVersion return the same results in the end I was wondering whether or not this can be improved.

In any case thank you for this project in combination with NuProj, something I've been looking for a long time now.

I have a PSDrive for my source repositories (e.g. Repos:). But scripts like Get-CommitId.ps1 use the $PWD or something without regard for expanding the actual file system path, and fails like so:

PS Repos:\Engine
[dev/heaths/bug241684] > .\packages\Nerdbank.GitVersioning.1.4.41\tools\Get-CommitId.ps1 1.1.22
New-Object : Exception calling ".ctor" with "2" argument(s): "Path 'Repos:\Engine' doesn't point at a valid Git
repository or workdir."
At C:\Users\heaths\Source\Repos\Engine\packages\Nerdbank.GitVersioning.1.4.41\tools\Get-CommitId.ps1:46 char:9
+ $repo = New-Object LibGit2Sharp.Repository($GitPath)
+         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [New-Object], MethodInvocationException
    + FullyQualifiedErrorId : ConstructorInvokedThrowException,Microsoft.PowerShell.Commands.NewObjectCommand

You cannot call a method on a null-valued expression.
At C:\Users\heaths\Source\Repos\Engine\packages\Nerdbank.GitVersioning.1.4.41\tools\Get-CommitId.ps1:51 char:5
+     $repo.Dispose()
+     ~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

Exception calling "GetCommitsFromVersion" with "3" argument(s): "Value cannot be null. Parameter name: repo"
At C:\Users\heaths\Source\Repos\Engine\packages\Nerdbank.GitVersioning.1.4.41\tools\Get-CommitId.ps1:48 char:5
+     $commit = [NerdBank.GitVersioning.GitExtensions]::GetCommitsFromV ...
+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [], MethodInvocationException
    + FullyQualifiedErrorId : ArgumentNullException

Unfortunately the native part does not work :(

/Volumes/data/git/pinvoke/src/packages/Nerdbank.GitVersioning.1.5.46/build/NerdBank.GitVersioning.targets: Error: Error executing task Nerdbank.GitVersioning.Tasks.GetBuildVersion: The type initializer for 'LibGit2Sharp.Core.NativeMethods' threw an exception. (CodeGeneration).

I'll take a look into it in the future to help. For now I'll just disable that on my machine.

When branches and tags are pushed, builds are sometimes automatically scheduled on build servers. For example on AppVeyor, pushing build tags kicks off a build with the APPVEYOR_REPO_TAG_NAME environment variable preset.

We can add a releaseRefRegex field to the version.json file such that when builds are kicked off based on tags or branches that match the regular expression provided then the PublicRelease MSBuild property is set to true automatically, thus producing a build without the -gCOMMITID suffix to the NuGet package versions.

This enables the flow of a build completing and being validated, then deciding to ship that version. The developer then pushes a tag (say... "v1.0.1") and that automatically kicks off a fresh build that is just "1.0.1" instead of "1.0.1-gabc123def".

GitVersioning may interfere with Markup Compilation for WPF applications and cause assembly load exception at runtime

This may not be a common scenario, and it has a simple workaround, so may not need a fix. I am logging it here in case other people encounter it.

Symptom: System.IO.FileLoadException thrown when wpf is trying to load resources in InitializeComponent

Background:

• GitVersioning sets the AssemblyVersion property to something like "14.1"
• MarkupCompilePass1 WPF target picks up the AssemblyVersion property and inserts it into the generated .g.cs based on the XAML:

        public void InitializeComponent() {
            // ...
            System.Uri resourceLocater = new System.Uri("/foo;V14.1;component/bar.xaml", System.UriKind.Relative);
            // ...
        }

• At runtime, when this method gets called, it first tries to match the assembly against loaded assemblies; however that fails in this case as it tries to match against the full version (14.1.0.0)
• Because it couldn't find the assembly (even it if was already in memory), it tries to load it. Most of the times that will succeed, but in some cases (e.g. the assembly is located somewhere else, not under the probing path) you will encounter this problem

Workaround: Insert the following snippet in the affected projects

  <Target Name="ClearAssemblyVersionBeforeMarkupCompilePass1" BeforeTargets="MarkupCompilePass1">
    <PropertyGroup>
      <AssemblyVersion />
    </PropertyGroup>
  </Target>

This will clear up the AssemblyVersion right before the MarkupCompilePass1 target gets executed. This will cause the version not to be specified in the generated file, and it will successfully match the assembly against the version already loaded in memory

Some projects, such as https://github.com/dotnet/corefx, set their AssemblyVersion to exactly match the NuGet package version.
I'm not sure why they have this policy, but we should enable it, even if it's not the default.

Another scenario is this project's own MSBuild Task. It is an implementation detail but must version closely with the .targets files. We've had many reports of the Task failing because the wrong version was already loaded due to MSBuild.exe processes lingering and being reused for another project that uses a different version of the .targets and Task.

❓ Should we merely use the 3rd integer (build number / git height) in the assembly version, or should we also use the 4th integer (truncated git commit ID) in the assembly version?

🅰️ We'll give the user the choice.

While $(NuGetPackageVersion) replaces the "+" with "-" and allows nuget pack to succeed, if you use -IncludeReferencedProjects nuget because the AssemblyInformationalVersionAttribute value is invalid.

What might be nice is to allow (opt-in, to avoid breaking compat) semver 1.0 versions. We were able to work around this by hooking in our own target, but others may run into this as well.

Tests fail in appveyor unless these commands are executed before the tests run:

git config --global user.name appveyor
git config --global user.email [email protected]

We should enhance the tests to not depend on machine configuration.

Spec

1. Support both file formats: version.txt will continue to be supported, alongside version.json. This is absolutely required so that repos already based on this project can upgrade to the latest version of this project yet continue to get the right version information for older commits.
2. Prefer version.json over version.txt when both files exist.
3. Define a json schema file so folks can get IntelliSense while modifying the file.

Consider

1. Automatically upgrade folks from version.txt to version.json when using the API to write the version file.

I keep getting following when trying to use the gitversioning package

1>Target "GetBuildVersion" in file "E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.targets" from project "E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\src\XLabs.Core\XLabs.Core.csproj" (target "GenerateAssemblyInfo" depends on it):
1>Using "GetBuildVersion" task from assembly "E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.Tasks.dll".
1>Task "GetBuildVersion"
1>E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.targets(30,5): error MSB4018: The "GetBuildVersion" task failed unexpectedly.
1>E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.targets(30,5): error MSB4018: System.NullReferenceException: Object reference not set to an instance of an object.
1>E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.targets(30,5): error MSB4018:    at Nerdbank.GitVersioning.GitExtensions.GetVersionHeight(Repository repo, String repoRelativeProjectDirectory)
1>E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.targets(30,5): error MSB4018:    at Nerdbank.GitVersioning.Tasks.GetBuildVersion.Execute()
1>E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.targets(30,5): error MSB4018:    at Microsoft.Build.BackEnd.TaskExecutionHost.Microsoft.Build.BackEnd.ITaskExecutionHost.Execute()
1>E:\Projects\Github\ravensorb\Xamarin-Forms-Labs\packages\Nerdbank.GitVersioning.1.2.1\build\Nerdbank.GitVersioning.targets(30,5): error MSB4018:    at Microsoft.Build.BackEnd.TaskBuilder.<ExecuteInstantiatedTask>d__26.MoveNext()
1>Done executing task "GetBuildVersion" -- FAILED.
1>Done building target "GetBuildVersion" in project "XLabs.Core.csproj" -- FAILED.

I have tried a rebuild all, a clean and then build, a full reboot, and still I get the same errors.

Here is the contents of my version.json file (it is at the solution level). I have also tried at the project level and get the same result

{ "version": "2.0.5818" }

When using Visual Studio 2013 to update to the new Nerdbank.GitVersioning.1.4.30 package, I get the following PowerShell error printed in the NuGet Package Manager output window in VS.

The error appears to be benign for me, but that might be because i am doing package upgrade and so my project already has version.json file.

HTH.

The "=" operator is missing after a named argument.
At E:\Depot\GitHub\ServerHost\packages\Nerdbank.GitVersioning.1.4.30\tools\Create-VersionFile.ps1:15 char:38
+ [CmdletBinding(SupportsShouldProcess) <<<< ]
    + CategoryInfo          : ParserError: (:) [], ParseException
    + FullyQualifiedErrorId : MissingEqualsInNamedArgument

------- Updating...Nerdbank.GitVersioning 1.4.30 -------
Installing 'Nerdbank.GitVersioning 1.4.30'.
Added file 'AppVeyor.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'CodeGenerationAttributes.Net40.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Nerdbank.GitVersioning.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build\dotnet'.
Added file 'LibGit2Sharp.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'git2-e0902fb.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build\NativeBinaries\amd64'.
Added file 'git2-e0902fb.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build\NativeBinaries\x86'.
Added file 'Nerdbank.GitVersioning.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'NerdBank.GitVersioning.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Nerdbank.GitVersioning.Tasks.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Newtonsoft.Json.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'PInvoke.MSCorEE.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Nerdbank.GitVersioning.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build\portable-net+win+wpa+wp+sl+netmf+MonoAndroid+MonoTouch+Xamarin.iOS'.
Added file 'Validation.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'VisualStudioTeamServices.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'readme.txt' to folder 'Nerdbank.GitVersioning.1.4.30'.
Added file 'Create-VersionFile.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Get-CommitId.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Get-Version.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Install.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'version.schema.json' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Nerdbank.GitVersioning.1.4.30.nupkg' to folder 'Nerdbank.GitVersioning.1.4.30'.
Successfully installed 'Nerdbank.GitVersioning 1.4.30'.
Looking for updates for 'Nerdbank.GitVersioning'...
Updating 'Nerdbank.GitVersioning' from version '1.4.19' to '1.4.30' in project 'ServerHost'.
Removing 'Nerdbank.GitVersioning 1.4.19' from ServerHost.
Added file 'packages.config'.
Successfully removed 'Nerdbank.GitVersioning 1.4.19' from ServerHost.
Adding 'Nerdbank.GitVersioning 1.4.30' to ServerHost.
For adding package 'Nerdbank.GitVersioning 1.4.30' to project 'ServerHost' that targets 'net45',
>> Build files are being added from 'build\portable-net+win+wpa+wp+sl+netmf+MonoAndroid+MonoTouch+Xamarin.iOS'
Added file 'packages.config'.
Successfully added 'Nerdbank.GitVersioning 1.4.30' to ServerHost.
For adding package 'Nerdbank.GitVersioning 1.4.30' to project 'ServerHost' that targets 'net45',
>> PowerShell scripts are being executed from 'tools' (not framework-specific)
Executing script file 'E:\Depot\GitHub\ServerHost\packages\Nerdbank.GitVersioning.1.4.30\tools\Install.ps1'.
Uninstalling 'Nerdbank.GitVersioning 1.4.19'.
Successfully uninstalled 'Nerdbank.GitVersioning 1.4.19'.
==============================

When the nuget.org package source is missing, or when other package sources are listed and require authentication, package restore can fail.
We should specify -Source on the nuget install command line to ensure it works reliably.

The BuildNumber project property is set by TFS Team Build, and thus this project's idea for BuildNumber isn't applied because it is only set by this project if the property is empty beforehand. We should remove the condition.

For backward compat, it is sometimes important to keep AssemblyVersion constant while still incrementing other versions. The version.txt file should support such a requirement.

When using Visual Studio 2013 to update to the new Nerdbank.GitVersioning.1.4.30 package, I get the following PowerShell error printed in the NuGet Package Manager output window in VS.

The error appears to be benign for me, but that might be because i am doing package upgrade and so my project already has version.json file.

HTH.

The "=" operator is missing after a named argument.
At E:\Depot\GitHub\ServerHost\packages\Nerdbank.GitVersioning.1.4.30\tools\Create-VersionFile.ps1:15 char:38
+ [CmdletBinding(SupportsShouldProcess) <<<< ]
    + CategoryInfo          : ParserError: (:) [], ParseException
    + FullyQualifiedErrorId : MissingEqualsInNamedArgument

------- Updating...Nerdbank.GitVersioning 1.4.30 -------
Installing 'Nerdbank.GitVersioning 1.4.30'.
Added file 'AppVeyor.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'CodeGenerationAttributes.Net40.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Nerdbank.GitVersioning.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build\dotnet'.
Added file 'LibGit2Sharp.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'git2-e0902fb.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build\NativeBinaries\amd64'.
Added file 'git2-e0902fb.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build\NativeBinaries\x86'.
Added file 'Nerdbank.GitVersioning.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'NerdBank.GitVersioning.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Nerdbank.GitVersioning.Tasks.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Newtonsoft.Json.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'PInvoke.MSCorEE.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'Nerdbank.GitVersioning.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build\portable-net+win+wpa+wp+sl+netmf+MonoAndroid+MonoTouch+Xamarin.iOS'.
Added file 'Validation.dll' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'VisualStudioTeamServices.targets' to folder 'Nerdbank.GitVersioning.1.4.30\build'.
Added file 'readme.txt' to folder 'Nerdbank.GitVersioning.1.4.30'.
Added file 'Create-VersionFile.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Get-CommitId.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Get-Version.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Install.ps1' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'version.schema.json' to folder 'Nerdbank.GitVersioning.1.4.30\tools'.
Added file 'Nerdbank.GitVersioning.1.4.30.nupkg' to folder 'Nerdbank.GitVersioning.1.4.30'.
Successfully installed 'Nerdbank.GitVersioning 1.4.30'.
Looking for updates for 'Nerdbank.GitVersioning'...
Updating 'Nerdbank.GitVersioning' from version '1.4.19' to '1.4.30' in project 'ServerHost'.
Removing 'Nerdbank.GitVersioning 1.4.19' from ServerHost.
Added file 'packages.config'.
Successfully removed 'Nerdbank.GitVersioning 1.4.19' from ServerHost.
Adding 'Nerdbank.GitVersioning 1.4.30' to ServerHost.
For adding package 'Nerdbank.GitVersioning 1.4.30' to project 'ServerHost' that targets 'net45',
>> Build files are being added from 'build\portable-net+win+wpa+wp+sl+netmf+MonoAndroid+MonoTouch+Xamarin.iOS'
Added file 'packages.config'.
Successfully added 'Nerdbank.GitVersioning 1.4.30' to ServerHost.
For adding package 'Nerdbank.GitVersioning 1.4.30' to project 'ServerHost' that targets 'net45',
>> PowerShell scripts are being executed from 'tools' (not framework-specific)
Executing script file 'E:\Depot\GitHub\ServerHost\packages\Nerdbank.GitVersioning.1.4.30\tools\Install.ps1'.
Uninstalling 'Nerdbank.GitVersioning 1.4.19'.
Successfully uninstalled 'Nerdbank.GitVersioning 1.4.19'.
==============================

Building with tools version "4.0".
Target GetBuildVersion:
Using "GetBuildVersion" task from assembly "C:\git\Nerdbank.GitVersioning\bin\Debug\Nerdbank.GitVersioning.Tasks.dll".
Task "GetBuildVersion"
C:\Users\andarno\AppData\Local\Temp\bck15d0j.z2a\NerdBank.GitVersioning.targets(22,5): error MSB4018: The "GetBuildVersion" task failed unexpectedly.
C:\Users\andarno\AppData\Local\Temp\bck15d0j.z2a\NerdBank.GitVersioning.targets(22,5): error MSB4018: System.NullReferenceException: Object reference not set to an instance of an object.
C:\Users\andarno\AppData\Local\Temp\bck15d0j.z2a\NerdBank.GitVersioning.targets(22,5): error MSB4018: at Nerdbank.GitVersioning.Tasks.GetBuildVersion.Execute() in C:\git\Nerdbank.GitVersioning\src\NerdBank.GitVersioning.Tasks\GetBuildVersion.cs:line 103
C:\Users\andarno\AppData\Local\Temp\bck15d0j.z2a\NerdBank.GitVersioning.targets(22,5): error MSB4018: at Microsoft.Build.BackEnd.TaskExecutionHost.Microsoft.Build.BackEnd.ITaskExecutionHost.Execute()
C:\Users\andarno\AppData\Local\Temp\bck15d0j.z2a\NerdBank.GitVersioning.targets(22,5): error MSB4018: at Microsoft.Build.BackEnd.TaskBuilder.d__1.MoveNext()
Done executing task "GetBuildVersion" -- FAILED.
Done building target "GetBuildVersion" in project "test.proj" -- FAILED.

Repro steps

1. Build, with a version.json set to "1.0-beta"
2. Change version.json to "1.0-rc"
3. Build

You'll see a build error due to the generated assemblyinfo.cs file having an extra closing curly because the shorter file isn't properly truncated.

We used to have code that was (supposed to) fix this, but I can't even find that any more where I would have expected it to be.

The NPM package versions with a git commit ID due to #70. This makes it search for a nuget.org package with a git commit id during package restore, which fails because it doesn't include it.

When a project uses this package and specifies a value for the Language property in MSBuild for which no CodeDomProvider can be found, the build fails due to the inability to generate an AssemblyInfo.cs file.

This breaks the build for NuProj with the common.targets changes, as it sets Language to 'NuGet'

We should either quietly skip assemblyinfo generation, or emit a warning, in such cases.

We like to distinguish one-off builds by including the branch name (sometimes just the last component of a develop topic branch) in the metadata of the package. It would be great if we could get this information from the build task and use it as part of the version for both binaries and nuget/npm packages.

The current behavior is:

The commit ID is not exposed frequently enough to be reliably present and useful.

The current proposal is that we leverage NuGet v3's support for +buildMetadata on the package version to enhance it to this:

Consider being even more aggressive:

This may need to start under an optional property that folks can control. We at least need to weigh the impact on the user experience and whether these packages can be consumed by NuGet v2.x clients.

Return this instead of System.Version if a switch is passed in.

Sample:

Get-Versoin.ps1 -SemVer

When using the Get-Version.ps1 script, the object returned does not have a field that varies based on whether the checked out branch is one of those specified by publicReleaseRefSpec in the version.json file.

This prevents npm packages from being versioned according to the same policies as a nuget package.

With cloud build numbering turned on, a repeat build in appveyor of the same commit (say, due to a tag being added, or the "Rebuild Commit" command) will fail the build when NB.GV tries to set the build number to one that collides with another that AppVeyor already has a record for.

In these instances, we should either emit a warning and continue, or perhaps add a unique suffix to the build number to resolve the collision.

In some cases it may be needed to adjust the git height value.
That could be easily be implemented by having an optional Offset value in the version.txt file.
By default, the value should be 0.

I am working through the integration with NuProj and am trying to get it working. I had a question regarding step 2 and 3. Are these changes needed in the nuproj file, the csproj files, nuproj.targets file?

.\Nerdbank.GitVersioning.NuGet\tools\Get-Version.ps1
Exception calling "GetIdAsVersion" with "2" argument(s): "Path should be relative to repo root.
Parameter name: repoRelativeProjectDirectory"

As found here