Skip to content

Version and Tag

Throughout this document, the terms "version" and "tag" are used interchangeably. The version applies to binaries, product, or repo tagging. The rules for ntools versioning are as follows:

  1. The version is a string in the format of X.Y.Z, where X, Y, and Z are integers.
  2. The version is incremented as follows:
    • X is the major number:
    • Incremented for breaking changes.
    • Y is the minor number:
    • Incremented for new features or bug fixes.
    • Incremented when production Build Type is deployed.
    • Incrementing Y resets Z to 0.
    • Z is the build number:
      • Incremented when staging Build Type is deployed.

Tags in the GitHubRelease are used to:

  • Identify specific versions of the repository.
  • Associate release assets with a particular version.
  • Generate release notes based on commits since the last tag.

Version Automation

Tool versions in documentation are automatically updated using the MSBuild task (UpdateVersionsInDocs) via the nb update_doc_versions command. This extracts all tool/version pairs from every NbuildAppList entry in every *.json file in dev-setup and updates the documentation table accordingly.

PowerShell Module Integration (v2.3.0+)

  • Module: scripts/module-package/ntools-scripts.psm1
  • Function: Get-VersionFromJson
  • Purpose: Consolidated version management within the ntools-scripts module
# Import the module
Import-Module "./scripts/module-package/ntools-scripts.psm1" -Force

# Get version from specific JSON file
$version = Get-VersionFromJson -JsonFilePath "./dev-setup/ntools.json"

For complete automation details, see Version Automation Guide.