Skip to content
This repository has been archived by the owner on May 9, 2024. It is now read-only.

Latest commit

 

History

History
15 lines (12 loc) · 1.17 KB

RELEASE.md

File metadata and controls

15 lines (12 loc) · 1.17 KB
Raw

HDK Release Process

HDK uses a semantic versioning scheme for software version numbers. The version number consists of MAJOR.MINOR.PATCH. The Major version increments each time the API changes. Minor versions indicate a new branch from the main code branch. Patch versions increment when there is a release from an existing release branch. Typically, patch versions will be released for bug fixes, where minor versions will include more substantive changes.

Release Checklist

  1. Create a new release branch with the name release/vMAJOR.MINOR.PATCH.
    • For major and minor version releases, create a branch from main.
    • For patch version releases, create a branch from the existing release branch on which the patch is going to be based (e.g. release/v0.1.1 would be branched from release/v0.1.0).
  2. Bump the version number in CMakeLists.txt in the release branch and remove the dev tag.
  3. Bump the version number in main if needed (e.g. when releasing v0.1.0, bump main to v0.2.0dev).
  4. Ensure CI on the release branch is green.
  5. Create a tag for the release.
  6. Create GitHub Release w/ source code archive.
  7. Build and publish updated conda-forge packages.