dotnet/Nerdbank.GitVersioning

Creates deterministic versions using git

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
path	The path to the directory for which the version should be determined. This should be at or below the directory containing the version.json file. Default is repo root directory.	no	.
setAllVars	Defines ALL version variables as environment variables, with a "NBGV_" prefix.	no	false
setCommonVars	Defines a few common version variables as environment variables, with a "Git" prefix (e.g. GitBuildVersion, GitBuildVersionSimple, GitAssemblyInformationalVersion).	no	false
stamp	The path to a file whose version setting should be changed to match the computed version. Supported file types: `package.json`.	no	—
toolVersion	The version of the nbgv dotnet CLI tool to install and use. If not specified, the default is the latest stable version.	no	—
toolFeed	An additional feed to search for the nbgv dotnet CLI tool. Default feeds may include https://api.nuget.org/v3/index.json or whatever is specified in a nuget.config file at the root of your repo.	no	—

Outputs

name	description
CloudBuildNumber	The cloud build number
VersionFileFound	A boolean value indicating whether a version.json file was found.
AssemblyVersion	The version to be used as the .NET assembly version.
AssemblyFileVersion	The version to be used as the .NET assembly file version.
AssemblyInformationalVersion	The version to be used as the .NET assembly informational version.
PublicRelease	A boolean value indicating whether this build is recognized as building from a public release branch.
PrereleaseVersion	The prerelease/unstable suffix to the version, including the hyphen.
PrereleaseVersionNoLeadingHyphen	The prerelease/unstable suffix to the version, without the leading hyphen.
SimpleVersion	The first 3 integers of the version.
BuildNumber	The build number (i.e. the third integer or PATCH) for this version.
VersionRevision	The fourth integer component of the version.
MajorMinorVersion	The "major.minor" portion of the version.
VersionMajor	The first integer of the version.
VersionMinor	The second integer of the version.
GitCommitId	The full SHA1 hash of the HEAD commit.
GitCommitIdShort	A truncated SHA1 hash of the HEAD commit (usually 10 characters)
GitCommitDate	The date of the git commit at HEAD
VersionHeight	The number of commits in the longest single path between the specified commit and the most distant ancestor (inclusive) that set the version to the value at HEAD.
VersionHeightOffset	The offset to add to VersionHeight when calculating the BuildNumber or wherever else the VersionHeight is used.
Version	The four integer version.
BuildMetadataFragment	The +metadata portion of the version, if any.
NuGetPackageVersion	The version to be used for NuGet packages.
ChocolateyPackageVersion	The version to be used for Chocolatey packages.
NpmPackageVersion	The version to be used for NPM packages.
SemVer1	The SemVer 1.0 compliant version.
SemVer2	The SemVer 2.0 compliant version.