FunFair.BuildVersion.Detection
6.2.16.888-main
This is a prerelease version of FunFair.BuildVersion.Detection.
There is a newer prerelease version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package FunFair.BuildVersion.Detection --version 6.2.16.888-main
NuGet\Install-Package FunFair.BuildVersion.Detection -Version 6.2.16.888-main
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="FunFair.BuildVersion.Detection" Version="6.2.16.888-main" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FunFair.BuildVersion.Detection --version 6.2.16.888-main
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: FunFair.BuildVersion.Detection, 6.2.16.888-main"
#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 FunFair.BuildVersion.Detection as a Cake Addin #addin nuget:?package=FunFair.BuildVersion.Detection&version=6.2.16.888-main&prerelease // Install FunFair.BuildVersion.Detection as a Cake Tool #tool nuget:?package=FunFair.BuildVersion.Detection&version=6.2.16.888-main&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Build Version
Simpler/faster git specific version builder
Build Status
Branch | Status |
---|---|
main | |
release |
Release Notes/Changelog
View changelog
Installation
Install as a global tool
dotnet tool install FunFair.BuildVersion
To update to latest released version
dotnet tool update FunFair.BuildVersion
Install as a local tool
dotnet new tool-manifest
dotnet tool install FunFair.BuildVersion --local
To update to latest released version
dotnet tool update FunFair.BuildVersion --local
Supported Branch formats
Supports release and hotfix branches in the following formats
- release/version
- release/package/version
- release-platform/package/version
- release-platform/version
- hotfix/version
- hotfix/package/version
- hotfix-platform/package/version
- hotfix-platform/version
version
can be in the following formats:
- 1
- 1.2
- 1.2.3
Output Release Formats
- Release branches: 1.2.3.4;
- where 4 is a build number passed to the tool
- Pre-Release branches 1.2.3.4-tag
- where
4
is a build number passed to the tool - where
tag
is generated from the branch name (or matching branch for a pull request if it can be located)
- where
Tag restrictions
- Maximum length before truncating after any processing: 15 characters
- Non alphanumeric characters are replaced with
-
- Multiple
-
consecutive characters are shrunk to a single one - removes the top folder of the branch when using branches like
feature/name
so that tag is processed onname
only - For Pull requests, if a branch cannot be located by its SHA hash then the tag will become
pr-id
whereid
is the id of the pull request - if no suitable tag can be generated the tag
prerelease
will be used.
Command line arguments
-x, --WarningsAsErrors (Default: false) Whether warnings should be errors
-b, --BuildNumber (Default: -1) The build number (use BUILD_NUMBER envrionment variable)
-s, --ReleaseSuffix (Default: ) The release suffix
-p, --Package (Default: ) The package being released
--help Display this help screen.
--version Display version information.
Running without arguments
This will attempt to retrieve the build number (counter) from an environment variable:
- BUILD_NUMBER (Set by CI tools like TeamCity)
dotnet buildversion
Running with release branches in format /release/version
dotnet buildversion --BuildNumber 272
or
dotnet buildversion --b272
Running with release branches in format /release-product/version
dotnet buildversion --BuildNumber 272 --ReleaseSuffix "product"
or
dotnet buildversion -b272 -s"product"
Running with release branches in format /release-product/package/version
dotnet buildversion --BuildNumber 272 --ReleaseSuffix "product" --Package "package"
or
dotnet buildversion -b272 -s"product" -p"package"
Running with release branches in format /release/package/version
dotnet buildversion --BuildNumber 272 --Package "package"
or
dotnet buildversion -b272 -p"package"
Integrations
TeamCity
- Picks up the
BUILD_NUMBER
environment variable for the build number - If
TEAMCITY_VERSION
environment variable is defined then thesystem.build.version
andbuildNumber
variables will be set to match the build version that the tool produces
GitHub Actions
- If
GITHUB_ENV
environment variable is defined then theBUILD_VERSION
environment variable will be set to match the build version that the tool produces.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Credfeto.Extensions.Linq (>= 1.0.51.546)
- FunFair.BuildVersion.Interfaces (>= 6.2.16.888-main)
- LibGit2Sharp (>= 0.31.0)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0)
-
net9.0
- Credfeto.Extensions.Linq (>= 1.0.51.546)
- FunFair.BuildVersion.Interfaces (>= 6.2.16.888-main)
- LibGit2Sharp (>= 0.31.0)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on FunFair.BuildVersion.Detection:
Package | Downloads |
---|---|
Credfeto.DotNet.Repo.Tools.Release
Dotnet Repository Update tools |
GitHub repositories
This package is not used by any popular GitHub repositories.