Table of Contents

Getting Started

Installation and Configuration

You can install Nerdbank.GitVersioning into your projects via NuGet or NPM. Source-preview adapters are also available for Rust, Go, Gradle, and Maven.

The non-.NET adapters are not yet claimed to be available from their ecosystem registries. Follow their source acquisition instructions and the ecosystem release status.

You must also create a version.json file in your repo. See migration notes if your repo already has a version.txt or version.json file from using another system.

Adopt a versioning workflow

Read the recommended versioning workflow for guidance on when to update version.json, how to stabilize and tag releases, and how to maintain servicing branches.

How to leverage version stamping and runtime information

See relevant documentation for any of these topics:

Build

We have docs to describe how to build with Nerdbank.GitVersioning for these build systems:

Also some special cloud build considerations (e.g. Azure Pipelines, GitHub Actions, etc.).