GitInfo 2.3.0

dotnet add package GitInfo --version 2.3.0
NuGet\Install-Package GitInfo -Version 2.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="GitInfo" Version="2.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GitInfo --version 2.3.0
#r "nuget: GitInfo, 2.3.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.3.0

// Install GitInfo as a Cake Tool
#tool nuget:?package=GitInfo&version=2.3.0

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)>

MSBuild:

  
<ItemGroup>
  <PackageReference Include="GitInfo" PrivateAssets="all" />
</ItemGroup>

<Target Name="PopulateInfo" DependsOnTargets="GitInfo" BeforeTargets="PrepareForBuild">
    <PropertyGroup>
      <RepositoryBranch>$(GitBranch)</RepositoryBranch>
      <RepositoryCommit>$(GitCommit)</RepositoryCommit>
      <SourceRevisionId>$(GitBranch) $(GitCommit)</SourceRevisionId>
    </PropertyGroup>
</Target>

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.

MSBuild

If you want to set other properties in your project, such as $(Version) or $(PackageVersion) based on the populated values from GitInfo, you must do so from a target, such as:

<Target Name="_SetVersion" BeforeTargets="GetAssemblyVersion;GenerateNuspec;GetPackageContents">
    <PropertyGroup>
        <Version>$(GitSemVerMajor).$(GitSemVerMinor).$(GitSemVerPatch)$(GitSemVerDashLabel)+$(GitBranch).$(GitCommit)</Version>
        <PackageVersion>$(Version)</PackageVersion>
    </PropertyGroup>
</Target>

In this case, we're setting the version and package version.

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 properties:

  $(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

Clarius Org Christian Findlay C. Augusto Proiete Kirill Osenkov MFB Technologies, Inc. SandRock Andy Gocke Shahzad Huq

Sponsor this project  

Learn more about GitHub Sponsors

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages (10)

Showing the top 5 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.

PH.RollingZipRotatorLog4net

A netstandard2.0 Zip utility to perform a very simple log4net file rotation. The code perform a zip-compression on every log-rotated file and delete it, watching on log4net output directory reading settings of appenders.

BizStream.NET.Sdk

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

Xamarin.VisualStudio.AndroidX.Migration The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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

GitHub repositories (30)

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.
veler/DevToys
A Swiss Army knife for developers.
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
moq/moq4
Repo for managing Moq 4.x
Version Downloads Last updated
2.3.0 6,412 11/18/2022
2.2.1 2,703 11/16/2022
2.2.0 661,800 8/26/2021
2.1.2 681,067 9/24/2020
2.1.1 574 9/24/2020
2.0.40 1,270 9/24/2020
2.0.39 1,861 9/23/2020
2.0.38 1,214 9/21/2020
2.0.37 860 9/20/2020
2.0.36 504 9/20/2020
2.0.35 504 9/20/2020
2.0.34 6,609 9/11/2020
2.0.33 9,716 8/28/2020
2.0.32 440 8/28/2020
2.0.31 62,341 8/3/2020
2.0.30 13,298 7/27/2020
2.0.29 9,527 7/22/2020
2.0.28 444 7/22/2020
2.0.27 439 7/22/2020
2.0.26 365,708 12/16/2019
2.0.25 1,421 12/13/2019
2.0.21 83,726 10/15/2019
2.0.20 553,852 11/13/2018
2.0.19 10,170 11/2/2018
2.0.18 97,172 9/26/2018
2.0.17 19,448 9/10/2018
2.0.16 797 9/10/2018
2.0.15 29,770 8/14/2018
2.0.14 1,988 8/3/2018
2.0.11 335,330 6/1/2018
2.0.10 32,450 2/21/2018
2.0.9 1,159 2/20/2018
2.0.8 13,239 11/30/2017
2.0.7 7,101 11/30/2017
2.0.6 17,016 10/22/2017
2.0.5 891 10/19/2017
2.0.3 8,195 10/18/2017
2.0.2 2,942 9/29/2017
2.0.1 88,211 8/24/2017
2.0.0 3,438 8/16/2017
1.1.72 1,795 8/7/2017
1.1.71 5,480 7/10/2017
1.1.70 864 7/10/2017
1.1.68 1,059 7/7/2017
1.1.67 1,170 7/4/2017
1.1.66 1,305 6/23/2017
1.1.65 1,176 6/15/2017
1.1.63 1,147 6/15/2017
1.1.62 2,335 6/4/2017
1.1.61 4,286 5/31/2017
1.1.60 1,685 5/16/2017
1.1.59 15,798 5/11/2017
1.1.58 1,191 5/5/2017
1.1.57 1,042 4/29/2017
1.1.56 912 4/28/2017
1.1.55 1,788 4/26/2017
1.1.54 882 4/26/2017
1.1.53 1,629 4/12/2017
1.1.48 3,093 2/10/2017
1.1.47 892 2/10/2017
1.1.45 2,498 1/27/2017
1.1.44 891 1/27/2017
1.1.43 971 1/25/2017
1.1.41 914 1/25/2017
1.1.40 1,258 1/6/2017
1.1.39 1,227 12/26/2016
1.1.38 1,674 12/26/2016
1.1.37 1,177 12/12/2016
1.1.35 1,853 11/29/2016
1.1.34 1,207 11/24/2016
1.1.31 1,635 9/13/2016
1.1.30 967 9/13/2016
1.1.29 1,545 9/3/2016
1.1.28 1,809 8/10/2016
1.1.27 1,040 8/8/2016
1.1.26 933 8/8/2016
1.1.25 2,511 7/28/2016
1.1.24 1,191 7/28/2016
1.1.23 1,177 7/28/2016
1.1.22 1,255 7/28/2016
1.1.20 1,877 6/4/2016
1.1.19 1,034 5/29/2016
1.1.17 966 5/26/2016
1.1.15 2,932 5/23/2016
1.1.14 2,098 5/22/2016
1.1.13 1,018 5/19/2016
1.1.12 3,110 4/24/2016
1.1.10 1,111 4/8/2016
1.1.9 994 3/31/2016
1.1.8 960 3/31/2016
1.1.7 926 3/31/2016
1.1.5 1,480 3/16/2016
1.1.4 949 3/16/2016
1.1.2 1,010 3/14/2016
1.1.1 1,557 3/12/2016
1.1.0 1,047 3/11/2016
1.0.64-pre 773 3/12/2016
1.0.63-pre 791 3/12/2016
1.0.62-pre 885 3/12/2016
1.0.61-pre 919 3/12/2016
1.0.60-pre 785 3/11/2016
1.0.59-pre 880 3/11/2016
1.0.58-pre 809 3/11/2016
1.0.56-pre 3,061 1/9/2016
1.0.55-pre 1,692 1/7/2016
1.0.54-pre 1,344 12/14/2015
1.0.53-pre 899 12/10/2015
1.0.52-pre 1,115 12/10/2015
1.0.51-pre 906 12/10/2015
1.0.50-pre 919 12/9/2015
1.0.49-pre 2,608 10/5/2015
1.0.48-pre 1,126 10/3/2015
1.0.47-pre 966 9/2/2015
1.0.46-pre 840 9/2/2015
1.0.45-pre 881 9/1/2015
1.0.44-pre 851 9/1/2015
1.0.43-pre 836 9/1/2015
1.0.42-pre 855 8/18/2015
1.0.41-pre 1,140 8/7/2015
1.0.40-pre 867 7/19/2015
1.0.39-pre 848 7/10/2015
1.0.38-pre 849 6/26/2015
1.0.37-pre 823 6/26/2015
1.0.36-pre 811 6/26/2015
1.0.35-pre 829 6/26/2015
1.0.34-pre 830 6/24/2015
1.0.33-pre 922 6/17/2015
1.0.31-pre 860 6/16/2015
1.0.30-pre 822 6/16/2015
1.0.29-pre 815 6/16/2015
1.0.28-pre 813 6/16/2015
1.0.27-pre 825 6/16/2015
1.0.26-pre 857 6/15/2015
1.0.25-pre 844 6/14/2015
1.0.24-pre 848 6/11/2015
1.0.23-pre 829 6/8/2015
1.0.22-pre 840 6/8/2015
1.0.21-pre 818 6/8/2015
1.0.20-pre 856 6/8/2015
1.0.19-pre 821 6/8/2015
1.0.18-pre 833 6/8/2015
1.0.16-pre 831 6/5/2015
1.0.15-pre 869 6/5/2015
1.0.14-pre 897 6/4/2015
1.0.11-pre 836 6/3/2015
1.0.10-pre 856 6/3/2015
1.0.9-pre 862 6/3/2015
1.0.8-pre 847 6/3/2015
1.0.7-pre 897 6/3/2015
1.0.6-pre 820 6/3/2015
1.0.5-pre 837 6/3/2015
1.0.4-pre 834 6/3/2015
1.0.3-pre 826 6/3/2015
1.0.1-pre 829 6/3/2015
1.0.0 1,165 2/22/2016
1.0.0-pre 823 5/26/2015
0.0.196 410 10/14/2020
0.0.195 416 10/5/2020
0.0.194 820 9/24/2020