Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.66 KB

RELEASE.md

File metadata and controls

38 lines (30 loc) · 1.66 KB

Release process

  1. Make sure ## Unreleased section exists in CHANGELOG.md

  2. Run Release Commit GitHub action. Select minor or patch as a dispatch value option. This follows the semver pattern.

    • minor if changes include new features or breaking changes
    • patch if the change only contains bug fixes

    This action does the following:

    1. Bumps Cargo.toml version by minor or patch
    2. Updates Cargo.lock with the new version
    3. Updates CHANGELOG.md ## Unreleased section to the new version
    4. Updates LICENSE-THIRD-PARTY.md
  3. Once the CI tests have passed, run the Release GitHub action. This will automatically do the following:

    1. Add a Git tag to the release commit with the new version number
    2. Create a release under GitHub releases with the changes mentioned in CHANGELOG
    3. Generate the various binaries and add it to the GitHub release
  4. Run the homebrew-tinted Update CLI tool GitHub action and specify tinty as the action input value. This will update the version for Homebrew