GitInfo 3.3.5

GitInfo

来自 MSBuild、C# 和 VB 的 Git 信息

从 MSBuild 和代码中检索 Git 信息的一种新颖且透明的方法，无需使用任何自定义任务或编译代码和工具，隐藏设置、格式化字符串等。

用法

通过 NuGet 安装

PM> Install-Package GitInfo

默认情况下，如果包含的项目是 C#、F# 或 VB 项目，编译时生成的源文件将包含所有 Git 信息，可以在程序集的任何地方访问，如 ThisAssembly（部分）类别及其嵌套 Git 静态类别中的常量。

Console.WriteLine(ThisAssembly.Git.Commit);

注意：您可能需要关闭并重新打开解决方案，以便 Visual Studio 在安装包后第一次刷新 intellisense 并显示 ThisAssembly 类型。

默认情况下，GitInfo 还将设置 $(Version) 和 $(PackageVersion)，.NET SDK 使用这些值推导 AssemblyInfo、FileVersion 和 InformationalVersion 值，以及用于打包。此默认版本格式化为以下已填充的 MSBuild 属性：$(GitSemVerMajor).$(GitSemVerMinor).$(GitSemVerPatch)$(GitSemVerDashLabel)+$(GitBranch).$(GitCommit)。

因此，在安装和构建/打包后，您将获得一些版本。

或者，您可以通过在项目文件中将 GitVersion=false 设置为退出默认版本控制，如果您只想利用 Git 信息和/或版本属性/常量。

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

这允许您使用提供的常量构建任何版本的属性，使用任何信息，无需设置、格式化字符串或任何东西，只需纯代码。

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

注意：当您自定义程序集版本属性时，需要关闭 .NET SDK 中对应的程序集版本属性生成，通过设置相关属性为 false：GenerateAssemblyVersionAttribute、GenerateAssemblyFileVersionAttribute 和 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>

注意：由于提供的属性是通过需要在它们可用之前运行的目标填充的，因此您不能在项目级别的 PropertyGroup 中使用 GitInfo 提供的属性。您只能在使用依赖于 GitInfo 相关目标的任何目标（通常是上述示例中的 GitVersion，如果您消费了 SemVer 属性）时使用它们。

由于这些信息在构建项目时始终可用，因此您永远不会依赖于生成版本的 CI 构建脚本，并且您总能本地编译与 CI 服务器构建的同一版本的程序集。

您可以在GitInfo 宣布博客文章中了解更多关于该项目的信息。

详细说明

提供以下信息，可以直接从任何依赖于 GitInfo 目标的 MSBuild 目标使用

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

对于 C#、F# 和 VB，还生成了常量，以便可以从代码中访问相同的信息

  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

可用的MSBuild 属性以自定义行为

  $(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+)$'

目标

• 无编译代码或工具 → 100% 透明度
• 通过 一个 NuGet 包 简单地添加/安装
• 无需学习格式字符串或设置
• 简单的、结构化的 .targets 文件，只包含纯 MSBuild 和无自定义任务
• 可选嵌入 Git 信息到程序集元数据中
• 可选使用 Git 信息构建任意程序集/文件的版本信息，既 在 C# 中，也 在 VB 中。
• 通过调整 C# 或 F# 或 VB 模板（包括在 NuGet 包 中）来修改/改进生成的代码
• 100% 支持增量构建和高性能（所有适当的输入/输出到位，Git 信息的智能缓存等）

赞助商

了解更多关于 GitHub 赞助者的信息