GitInfo 2.2.0

Install-Package GitInfo -Version 2.2.0
dotnet add package GitInfo --version 2.2.0
<PackageReference Include="GitInfo" Version="2.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GitInfo --version 2.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: GitInfo, 2.2.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install GitInfo as a Cake Addin
#addin nuget:?package=GitInfo&version=2.2.0

// Install GitInfo as a Cake Tool
#tool nuget:?package=GitInfo&version=2.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Icon GitInfo

Git Info from MSBuild, C# and VB

A fresh and transparent approach to Git information retrieval from MSBuild and Code without using any custom tasks or compiled code and tools, obscure settings, format strings, etc.

Build status Latest version Downloads License

Usage

After installing via NuGet:

PM> Install-Package GitInfo

By default, if the containing project is a C#, F# or VB project, a compile-time generated source file will contain all the git information and can be accessed from anywhere within the assembly, as constants in a ThisAssembly (partial) class and its nested Git static class:

Console.WriteLine(ThisAssembly.Git.Commit);

All generated constants also have a Summary documentation tag that shows the current value in the intellisense tooltip, making it easier to see what the different values contain:

NOTE: you may need to close and reopen the solution in order for Visual Studio to refresh intellisense and show the ThisAssembly type the first time after installing the package.

With this information at your fingertips, you can build any versioning attributes you want, with whatever information you want, without resorting to settings, format strings or anything, just plain code:

C#:

[assembly: AssemblyVersion (ThisAssembly.Git.BaseVersion.Major + "." + ThisAssembly.Git.BaseVersion.Minor + "." + ThisAssembly.Git.BaseVersion.Patch)]

[assembly: AssemblyFileVersion (ThisAssembly.Git.SemVer.Major + "." + ThisAssembly.Git.SemVer.Minor + "." + ThisAssembly.Git.SemVer.Patch)]

[assembly: AssemblyInformationalVersion (
	ThisAssembly.Git.SemVer.Major + "." + 
	ThisAssembly.Git.SemVer.Minor + "." + 
	ThisAssembly.Git.Commits + "-" + 
	ThisAssembly.Git.Branch + "+" + 
	ThisAssembly.Git.Commit)]

F#:

module AssemblyInfo

open System.Reflection

[<assembly: AssemblyVersion (ThisAssembly.Git.BaseVersion.Major + "." + ThisAssembly.Git.BaseVersion.Minor + "." + ThisAssembly.Git.BaseVersion.Patch)>]

[<assembly: AssemblyFileVersion (ThisAssembly.Git.SemVer.Major + "." + ThisAssembly.Git.SemVer.Minor + "." + ThisAssembly.Git.SemVer.Patch)>]

[<assembly: AssemblyInformationalVersion (
    ThisAssembly.Git.SemVer.Major + "." + 
    ThisAssembly.Git.SemVer.Minor + "." + 
    ThisAssembly.Git.Commits + "-" + 
    ThisAssembly.Git.Branch + "+" + 
    ThisAssembly.Git.Commit)>]

do ()

VB:

<Assembly: AssemblyVersion(ThisAssembly.Git.BaseVersion.Major + "." + ThisAssembly.Git.BaseVersion.Minor + "." + ThisAssembly.Git.BaseVersion.Patch)>
<Assembly: AssemblyFileVersion(ThisAssembly.Git.SemVer.Major + "." + ThisAssembly.Git.SemVer.Minor + "." + ThisAssembly.Git.SemVer.Patch)>
<Assembly: AssemblyInformationalVersion(
    ThisAssembly.Git.SemVer.Major + "." +
    ThisAssembly.Git.SemVer.Minor + "." +
    ThisAssembly.Git.Commits + "-" +
    ThisAssembly.Git.Branch + "+" +
    ThisAssembly.Git.Commit)>

Because this information is readily available whenever you build the project, you never depend on CI build scripts that generate versions for you, and you can always compile locally exactly the same version of an assembly that was built by a CI server.

You can read more about this project at the GitInfo announcement blog post.

Details

Exposes the following information for use directly from any MSBuild target that depends on the GitInfo target:

  $(GitRepositoryUrl)
  $(GitBranch)
  $(GitCommit)
  $(GitCommitDate)
  $(GitCommits)
  $(GitTag)
  $(GitBaseTag)
  $(GitBaseVersionMajor)
  $(GitBaseVersionMinor)
  $(GitBaseVersionPatch)
  $(GitSemVerMajor)
  $(GitSemVerMinor)
  $(GitSemVerPatch)
  $(GitSemVerLabel)
  $(GitSemVerDashLabel)
  $(GitSemVerSource)
  $(GitIsDirty)

From C#, F# and VB, by default code is generated too so that the same information can be accessed from code, to construct your own assembly/file version attributes with whatever format you want:

[assembly: AssemblyVersion (ThisAssembly.Git.SemVer.Major + "." + ThisAssembly.Git.SemVer.Minor + "." + ThisAssembly.Git.SemVer.Patch)]
[assembly: AssemblyInformationalVersion (
  ThisAssembly.Git.SemVer.Major + "." +
  ThisAssembly.Git.SemVer.Minor + "." +
  ThisAssembly.Git.SemVer.Patch + "-" +
  ThisAssembly.Git.Branch + "+" +
  ThisAssembly.Git.Commit)]
// i..e ^: 1.0.2-main+c218617

NOTE: you may need to close and reopen the solution in order for Visual Studio to refresh intellisense and show the ThisAssembly type right after package installation for the first time.

All generated constants also have a Summary documentation tag that shows the current value in the intellisense tooltip, making it very easy to see what the different values contain.

The available constants from code are:

  ThisAssembly.Git.RepositoryUrl
  ThisAssembly.Git.Branch
  ThisAssembly.Git.Commit
  ThisAssembly.Git.Commits
  ThisAssembly.Git.Tag
  ThisAssembly.Git.BaseTag
  ThisAssembly.Git.BaseVersion.Major
  ThisAssembly.Git.BaseVersion.Minor
  ThisAssembly.Git.BaseVersion.Patch
  ThisAssembly.Git.SemVer.Major
  ThisAssembly.Git.SemVer.Minor
  ThisAssembly.Git.SemVer.Patch
  ThisAssembly.Git.SemVer.Label
  ThisAssembly.Git.SemVer.DashLabel
  ThisAssembly.Git.SemVer.Source
  ThisAssembly.Git.IsDirty

Available MSBuild customizations:

  $(GitThisAssembly): set to 'false' to prevent assembly 
                      metadata and constants generation.

  $(GitThisAssemblyMetadata): set to 'false' to prevent assembly 
                              metadata generation only. Defaults 
                              to 'false'.

  $(ThisAssemblyNamespace): allows overriding the namespace
                            for the ThisAssembly class.
                            Defaults to the global namespace.

  $(GitRemote): name of remote to get repository url for.
                Defaults to 'origin'.

  $(GitDefaultBranch): determines the base branch used to 
                       calculate commits on top of current branch.
                       Defaults to 'master'.

  $(GitVersionFile): determines the name of a file in the Git 
                     repository root used to provide the base 
                     version info.
                     Defaults to 'GitInfo.txt'.

  $(GitInfoReportImportance): allows rendering all the retrieved
                              git information with the specified
                              message importance ('high', 
                              'normal' or 'low').
                              Defaults to 'low'.

  $(GitIgnoreBranchVersion) and $(GitIgnoreTagVersion): determines 
                            whether the branch and tags (if any) 
                            will be used to find a base version.
                            Defaults to empty value (no ignoring).

  $(GitSkipCache): whether to cache the Git information determined
           in a previous build in a GitInfo.cache for
           performance reasons.
           Defaults to empty value (no ignoring).

  $(GitNameRevOptions): Options passed to git name-rev when finding
              a branch name for the current commit (Detached head). The default is
              '--refs=refs/heads/* --no-undefined --alwas'
              meaning branch names only, falling back to commit hash.
              For legacy behavior where $(GitBranch) for detached head
              can also be a tag name, use '--refs=refs/*'.
              Refs can be included and excluded, see git name-rev docs.

  $(GitTagRegex): Regular expression used with git describe to filter the tags 
                  to consider for base version lookup.
                  Defaults to * (all)
           
  $(GitBaseVersionRegex): Regular expression used to match and validate valid base versions
                          in branch, tag or file sources. By default, matches any string that 
                          *ends* in a valid SemVer2 string.
                          Defaults to 'v?(?<MAJOR>\d+)\.(?<MINOR>\d+)\.(?<PATCH>\d+)(?:\-(?<LABEL>[\dA-Za-z\-\.]+))?$|^(?<LABEL>[\dA-Za-z\-\.]+)\-v?(?<MAJOR>\d+)\.(?<MINOR>\d+)\.(?<PATCH>\d+)$'

Goals

  • No compiled code or tools → 100% transparency
  • Trivially added/installed via a NuGet package
  • No format strings or settings to learn
  • Single well-structured .targets file with plain MSBuild and no custom tasks
  • Optional embedding of Git info in assembly as metadata
  • Optional use of Git info to build arbitrary assembly/file version information, both in C# as well as VB.
  • Trivially modified/improved generated code by just adjusting a C# or F# or VB template included in the NuGet package
  • Easily modified/improved by just adjusting a single .targets file
  • 100% incremental build-friendly and high-performing (all proper Inputs/Outputs in place, smart caching of Git info, etc.)

Sponsors

sponsored clariusclarius

get mentioned here too!

This package has no dependencies.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on GitInfo:

Package Downloads
Aqovia.PactProducerVerifier.AspNetCore

Pact Producer Test for aspnet core sites

Zooqle.Net

A .NET Standard library for searching torrents on Zooqle.

Xamarin.VisualStudio.AndroidX.Migration

This package provides a Roslyn based migrator to be used in Visual Studio and Visual Studio for Mac.

BizStream.NET.Sdk

Core build and release configuration for packages and libraries distributed by BizStream.

GitHub repositories (20)

Showing the top 5 popular GitHub repositories that depend on GitInfo:

Repository Stars
dotnet/maui
.NET MAUI is the .NET Multi-platform App UI, a framework for building native device applications spanning mobile, tablet, and desktop.
gitextensions/gitextensions
Git Extensions is a standalone UI tool for managing git repositories. It also integrates with Windows Explorer and Microsoft Visual Studio (2015/2017/2019).
xamarin/Xamarin.Forms
Xamarin.Forms Official Home
EventStore/EventStore
The stream database optimised for event sourcing
moq/moq4
Repo for managing Moq 4.x
Version Downloads Last updated
2.2.0 36,848 8/26/2021
2.1.2 390,908 9/24/2020
2.1.1 395 9/24/2020
2.0.40 836 9/24/2020
2.0.39 1,016 9/23/2020
2.0.38 1,015 9/21/2020
2.0.37 688 9/20/2020
2.0.36 329 9/20/2020
2.0.35 348 9/20/2020
2.0.34 4,743 9/11/2020
2.0.33 8,973 8/28/2020
2.0.32 258 8/28/2020
2.0.31 50,182 8/3/2020
2.0.30 6,286 7/27/2020
2.0.29 4,622 7/22/2020
2.0.28 287 7/22/2020
2.0.27 263 7/22/2020
2.0.26 293,717 12/16/2019
2.0.25 1,066 12/13/2019
2.0.21 74,833 10/15/2019
2.0.20 486,569 11/13/2018
2.0.19 9,176 11/2/2018
2.0.18 92,172 9/26/2018
2.0.17 12,230 9/10/2018
2.0.16 592 9/10/2018
2.0.15 17,776 8/14/2018
2.0.14 1,723 8/3/2018
2.0.11 327,315 6/1/2018
2.0.10 31,750 2/21/2018
2.0.9 903 2/20/2018
2.0.8 12,277 11/30/2017
2.0.7 6,806 11/30/2017
2.0.6 16,096 10/22/2017
2.0.5 677 10/19/2017
2.0.3 6,661 10/18/2017
2.0.2 2,669 9/29/2017
2.0.1 86,941 8/24/2017
2.0.0 3,180 8/16/2017
1.1.72 1,496 8/7/2017
1.1.71 4,698 7/10/2017
1.1.70 637 7/10/2017
1.1.68 837 7/7/2017
1.1.67 922 7/4/2017
1.1.66 1,072 6/23/2017
1.1.65 959 6/15/2017
1.1.63 856 6/15/2017
1.1.62 2,096 6/4/2017
1.1.61 4,037 5/31/2017
1.1.60 1,411 5/16/2017
1.1.59 15,569 5/11/2017
1.1.58 966 5/5/2017
1.1.57 801 4/29/2017
1.1.56 690 4/28/2017
1.1.55 784 4/26/2017
1.1.54 666 4/26/2017
1.1.53 1,319 4/12/2017
1.1.48 2,729 2/10/2017
1.1.47 673 2/10/2017
1.1.45 2,276 1/27/2017
1.1.44 658 1/27/2017
1.1.43 752 1/25/2017
1.1.41 695 1/25/2017
1.1.40 1,012 1/6/2017
1.1.39 1,004 12/26/2016
1.1.38 1,254 12/26/2016
1.1.37 949 12/12/2016
1.1.35 1,576 11/29/2016
1.1.34 878 11/24/2016
1.1.31 1,299 9/13/2016
1.1.30 692 9/13/2016
1.1.29 1,306 9/3/2016
1.1.28 1,570 8/10/2016
1.1.27 818 8/8/2016
1.1.26 714 8/8/2016
1.1.25 1,982 7/28/2016
1.1.24 737 7/28/2016
1.1.23 719 7/28/2016
1.1.22 758 7/28/2016
1.1.20 1,600 6/4/2016
1.1.19 779 5/29/2016
1.1.17 726 5/26/2016
1.1.15 2,698 5/23/2016
1.1.14 1,855 5/22/2016
1.1.13 770 5/19/2016
1.1.12 2,584 4/24/2016
1.1.10 884 4/8/2016
1.1.9 771 3/31/2016
1.1.8 719 3/31/2016
1.1.7 702 3/31/2016
1.1.5 1,251 3/16/2016
1.1.4 726 3/16/2016
1.1.2 782 3/14/2016
1.1.1 1,299 3/12/2016
1.1.0 792 3/11/2016
1.0.64-pre 650 3/12/2016
1.0.63-pre 660 3/12/2016
1.0.62-pre 726 3/12/2016
1.0.61-pre 764 3/12/2016
1.0.60-pre 660 3/11/2016
1.0.59-pre 731 3/11/2016
1.0.58-pre 678 3/11/2016
1.0.56-pre 2,916 1/9/2016
1.0.55-pre 1,540 1/7/2016
1.0.54-pre 1,165 12/14/2015
1.0.53-pre 749 12/10/2015
1.0.52-pre 964 12/10/2015
1.0.51-pre 756 12/10/2015
1.0.50-pre 762 12/9/2015
1.0.49-pre 2,056 10/5/2015
1.0.48-pre 780 10/3/2015
1.0.47-pre 828 9/2/2015
1.0.46-pre 704 9/2/2015
1.0.45-pre 737 9/1/2015
1.0.44-pre 710 9/1/2015
1.0.43-pre 699 9/1/2015
1.0.42-pre 718 8/18/2015
1.0.41-pre 719 8/7/2015
1.0.40-pre 680 7/19/2015
1.0.39-pre 698 7/10/2015
1.0.38-pre 710 6/26/2015
1.0.37-pre 695 6/26/2015
1.0.36-pre 678 6/26/2015
1.0.35-pre 694 6/26/2015
1.0.34-pre 695 6/24/2015
1.0.33-pre 789 6/17/2015
1.0.31-pre 719 6/16/2015
1.0.30-pre 688 6/16/2015
1.0.29-pre 680 6/16/2015
1.0.28-pre 685 6/16/2015
1.0.27-pre 697 6/16/2015
1.0.26-pre 730 6/15/2015
1.0.25-pre 718 6/14/2015
1.0.24-pre 715 6/11/2015
1.0.23-pre 706 6/8/2015
1.0.22-pre 694 6/8/2015
1.0.21-pre 693 6/8/2015
1.0.20-pre 714 6/8/2015
1.0.19-pre 702 6/8/2015
1.0.18-pre 695 6/8/2015
1.0.16-pre 688 6/5/2015
1.0.15-pre 705 6/5/2015
1.0.14-pre 737 6/4/2015
1.0.11-pre 699 6/3/2015
1.0.10-pre 702 6/3/2015
1.0.9-pre 692 6/3/2015
1.0.8-pre 687 6/3/2015
1.0.7-pre 748 6/3/2015
1.0.6-pre 678 6/3/2015
1.0.5-pre 691 6/3/2015
1.0.4-pre 699 6/3/2015
1.0.3-pre 676 6/3/2015
1.0.1-pre 684 6/3/2015
1.0.0 773 2/22/2016
1.0.0-pre 684 5/26/2015
0.0.196 263 10/14/2020
0.0.195 248 10/5/2020
0.0.194 476 9/24/2020