Getting Started

Installation and Configuration

You can install Nerdbank.GitVersioning into your projects via NuGet or NPM.

• Use the nbgv .NET Core CLI tool (recommended)
• NuGet installation instructions
• NPM installation instructions
• Cake Build installation instructions

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:

• .NET
• Node
• Python
• VSIX

Build

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

• MSBuild
• gulp
• Cake Build

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