GitInfo 3.3.4

dotnet add package GitInfo --version 3.3.4
NuGet\Install-Package GitInfo -Version 3.3.4
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="3.3.4">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GitInfo --version 3.3.4
#r "nuget: GitInfo, 3.3.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. 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=3.3.4

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

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.

Latest version Downloads License Build status

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

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.

By default, GitInfo will also set $(Version) and $(PackageVersion) which the .NET SDK uses for deriving the AssemblyInfo, FileVersion and InformationalVersion values, as well as for packing. This default version is formatted from the following populated MSBuild properties: $(GitSemVerMajor).$(GitSemVerMinor).$(GitSemVerPatch)$(GitSemVerDashLabel)+$(GitBranch).$(GitCommit).

So, straight after install and build/pack, you will get some versioning in place 😃.

Alternatively, you can opt-out of this default versioning by setting GitVersion=false in your project file, if you want to just leverage the Git information and/or version properties/constants yourself:

<PropertyGroup>
    <GitVersion>false</GitVersion>
</PropertyGroup>

This allows you to use the provided constants to 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)>

NOTE: when generating your own assembly version attributes, you will need to turn off the corresponding assembly version attribute generation from the .NET SDK, by setting the relevant properties to false: GenerateAssemblyVersionAttribute, GenerateAssemblyFileVersionAttribute and GenerateAssemblyInformationalVersionAttribute.

MSBuild:

  
<PropertyGroup>
    
    <GitVersion>false</GitVersion>
</PropertyGroup>
<ItemGroup>
  <PackageReference Include="GitInfo" PrivateAssets="all" />
</ItemGroup>

<Target Name="PopulateInfo" DependsOnTargets="GitVersion" BeforeTargets="GetAssemblyVersion;GenerateNuspec;GetPackageContents">
    <PropertyGroup>
      <Version>$(GitSemVerMajor).$(GitSemVerMinor).$(GitSemVerPatch)$(GitSemVerDashLabel)+$(GitBranch).$(GitCommit)</Version>
      <PackageVersion>$(Version)</PackageVersion>
      
      <RepositoryBranch>$(GitBranch)</RepositoryBranch>
      <RepositoryCommit>$(GitCommit)</RepositoryCommit>
      <SourceRevisionId>$(GitBranch) $(GitCommit)</SourceRevisionId>
    </PropertyGroup>
</Target>

NOTE: because the provided properties are populated via targets that need to run before they are available, you cannot use the GitInfo-provided properties in a PropertyGroup at the project level. You can only use them from within a target that in turn depends on the relevant target from GitInfo (typically, GitVersion as shown above, if you consume the SemVer properties).

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)

For C#, F# and VB, constants are generated too so that the same information can be accessed from code:

  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 to customize the behavior:

  $(GitVersion): set to 'false' to prevent setting Version 
                 and PackageVersion.

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

  $(GitThisAssemblyMetadata): set to 'false' to prevent assembly 
                              metadata generation only. Defaults 
                              to 'false'. If 'true', it will also 
                              provide assembly metadata attributes 
                              for each of the populated values.

  $(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 'main'.

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

  $(GitCachePath): where to cache the determined Git information
				   gives the chance to use a shared location
				   for different projects. this can improve
				   the overall build time.
				   has to end with a path seperator
				   Defaults to empty value ('$(IntermediateOutputPath)').

  $(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 --always'
              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
  • Simple well-structured .targets file with plain MSBuild and no custom tasks
  • Optional embedding of Git info in assembly 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
  • 100% incremental build-friendly and high-performing (all proper Inputs/Outputs in place, smart caching of Git info, etc.)

Sponsors

Clarius Org Kirill Osenkov MFB Technologies, Inc. Stephen Shaw Torutek DRIVE.NET, Inc. Daniel Gnägi Ashley Medway Keith Pickford Thomas Bolon Kori Francis Sean Killeen Toni Wenzel Giorgi Dalakishvili Mike James Dan Siegel Reuben Swartz Jacob Foshee alternate text is missing from this package README image Eric Johnson Norman Mackay Certify The Web Ix Technologies B.V. David JENNI Jonathan Oleg Kyrylchuk Charley Wu Jakob Tikjøb Andersen Seann Alexander Tino Hager Mark Seemann Angelo Belchior Ken Bonny Simon Cropp agileworks-eu sorahex Zheyu Shen Vezel

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.

NuGet packages (11)

Showing the top 5 NuGet packages that depend on GitInfo:

Package Downloads
Aqovia.PactProducerVerifier.AspNetCore

Pact Producer Test for aspnet core sites

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.

Zooqle.Net

A .NET Standard library for searching torrents on Zooqle.

BizStream.NET.Sdk

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

SPLogging.Web

Web Log helper ใช้สำหรับ ช่วยเก็บค่า sesion และ อื่นๆ สำหรับ log

GitHub repositories (37)

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

Repository Stars
DevToys-app/DevToys
A Swiss Army knife for developers.
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
EventStoreDB, the event-native database. Designed for Event Sourcing, Event-Driven, and Microservices architectures
Version Downloads Last updated
3.3.4 24,497 2/15/2024
3.3.3 212,028 8/30/2023
3.3.2 352 8/30/2023
3.3.1 15,073 8/11/2023
3.3.0 581 8/11/2023
3.2.0 3,765 8/11/2023
2.3.0 526,115 11/18/2022
2.2.1 8,493 11/16/2022
2.2.0 1,296,794 8/26/2021
2.1.2 1,024,881 9/24/2020
2.1.1 804 9/24/2020
2.0.40 1,983 9/24/2020
2.0.39 2,986 9/23/2020
2.0.38 1,459 9/21/2020
2.0.37 1,075 9/20/2020
2.0.36 731 9/20/2020
2.0.35 720 9/20/2020
2.0.34 8,134 9/11/2020
2.0.33 10,990 8/28/2020
2.0.32 679 8/28/2020
2.0.31 65,965 8/3/2020
2.0.30 14,712 7/27/2020
2.0.29 43,187 7/22/2020
2.0.28 698 7/22/2020
2.0.27 704 7/22/2020
2.0.26 432,365 12/16/2019
2.0.25 1,649 12/13/2019
2.0.21 89,502 10/15/2019
2.0.20 632,760 11/13/2018
2.0.19 11,453 11/2/2018
2.0.18 102,481 9/26/2018
2.0.17 20,714 9/10/2018
2.0.16 1,003 9/10/2018
2.0.15 53,197 8/14/2018
2.0.14 2,421 8/3/2018
2.0.11 339,979 6/1/2018
2.0.10 33,194 2/21/2018
2.0.9 1,413 2/20/2018
2.0.8 15,114 11/30/2017
2.0.7 7,372 11/30/2017
2.0.6 18,338 10/22/2017
2.0.5 1,131 10/19/2017
2.0.3 8,445 10/18/2017
2.0.2 3,221 9/29/2017
2.0.1 88,865 8/24/2017
2.0.0 3,820 8/16/2017
1.1.72 2,110 8/7/2017
1.1.71 6,195 7/10/2017
1.1.70 1,106 7/10/2017
1.1.68 1,287 7/7/2017
1.1.67 1,404 7/4/2017
1.1.66 1,523 6/23/2017
1.1.65 1,410 6/15/2017
1.1.63 1,442 6/15/2017
1.1.62 2,574 6/4/2017
1.1.61 4,552 5/31/2017
1.1.60 1,929 5/16/2017
1.1.59 16,064 5/11/2017
1.1.58 1,404 5/5/2017
1.1.57 1,302 4/29/2017
1.1.56 1,129 4/28/2017
1.1.55 5,232 4/26/2017
1.1.54 1,135 4/26/2017
1.1.53 1,932 4/12/2017
1.1.48 3,449 2/10/2017
1.1.47 1,089 2/10/2017
1.1.45 2,739 1/27/2017
1.1.44 1,099 1/27/2017
1.1.43 1,194 1/25/2017
1.1.41 1,140 1/25/2017
1.1.40 1,501 1/6/2017
1.1.39 1,445 12/26/2016
1.1.38 1,917 12/26/2016
1.1.37 1,391 12/12/2016
1.1.35 2,142 11/29/2016
1.1.34 1,478 11/24/2016
1.1.31 1,868 9/13/2016
1.1.30 1,184 9/13/2016
1.1.29 1,816 9/3/2016
1.1.28 2,213 8/10/2016
1.1.27 1,257 8/8/2016
1.1.26 1,149 8/8/2016
1.1.25 2,771 7/28/2016
1.1.24 1,421 7/28/2016
1.1.23 1,430 7/28/2016
1.1.22 1,513 7/28/2016
1.1.20 2,190 6/4/2016
1.1.19 1,273 5/29/2016
1.1.17 1,179 5/26/2016
1.1.15 3,156 5/23/2016
1.1.14 2,359 5/22/2016
1.1.13 1,269 5/19/2016
1.1.12 3,328 4/24/2016
1.1.10 1,369 4/8/2016
1.1.9 1,222 3/31/2016
1.1.8 1,174 3/31/2016
1.1.7 1,172 3/31/2016
1.1.5 1,711 3/16/2016
1.1.4 1,182 3/16/2016
1.1.2 1,227 3/14/2016
1.1.1 1,808 3/12/2016
1.1.0 1,282 3/11/2016
1.0.64-pre 878 3/12/2016
1.0.63-pre 933 3/12/2016
1.0.62-pre 1,034 3/12/2016
1.0.61-pre 1,039 3/12/2016
1.0.60-pre 916 3/11/2016
1.0.59-pre 1,033 3/11/2016
1.0.58-pre 908 3/11/2016
1.0.56-pre 3,168 1/9/2016
1.0.55-pre 1,808 1/7/2016
1.0.54-pre 1,536 12/14/2015
1.0.53-pre 1,042 12/10/2015
1.0.52-pre 1,266 12/10/2015
1.0.51-pre 1,036 12/10/2015
1.0.50-pre 1,073 12/9/2015
1.0.49-pre 2,745 10/5/2015
1.0.48-pre 1,267 10/3/2015
1.0.47-pre 1,108 9/2/2015
1.0.46-pre 959 9/2/2015
1.0.45-pre 1,015 9/1/2015
1.0.44-pre 977 9/1/2015
1.0.43-pre 969 9/1/2015
1.0.42-pre 980 8/18/2015
1.0.41-pre 1,299 8/7/2015
1.0.40-pre 1,015 7/19/2015
1.0.39-pre 969 7/10/2015
1.0.38-pre 985 6/26/2015
1.0.37-pre 935 6/26/2015
1.0.36-pre 951 6/26/2015
1.0.35-pre 969 6/26/2015
1.0.34-pre 983 6/24/2015
1.0.33-pre 1,038 6/17/2015
1.0.31-pre 1,004 6/16/2015
1.0.30-pre 963 6/16/2015
1.0.29-pre 950 6/16/2015
1.0.28-pre 960 6/16/2015
1.0.27-pre 972 6/16/2015
1.0.26-pre 1,000 6/15/2015
1.0.25-pre 979 6/14/2015
1.0.24-pre 1,008 6/11/2015
1.0.23-pre 961 6/8/2015
1.0.22-pre 963 6/8/2015
1.0.21-pre 972 6/8/2015
1.0.20-pre 994 6/8/2015
1.0.19-pre 966 6/8/2015
1.0.18-pre 973 6/8/2015
1.0.16-pre 976 6/5/2015
1.0.15-pre 1,002 6/5/2015
1.0.14-pre 1,032 6/4/2015
1.0.11-pre 939 6/3/2015
1.0.10-pre 986 6/3/2015
1.0.9-pre 993 6/3/2015
1.0.8-pre 964 6/3/2015
1.0.7-pre 1,026 6/3/2015
1.0.6-pre 951 6/3/2015
1.0.5-pre 941 6/3/2015
1.0.4-pre 982 6/3/2015
1.0.3-pre 960 6/3/2015
1.0.1-pre 979 6/3/2015
1.0.0 1,421 2/22/2016
1.0.0-pre 948 5/26/2015
0.0.196 600 10/14/2020
0.0.195 613 10/5/2020
0.0.194 2,061 9/24/2020