Skip to content

Latest commit

 

History

History
47 lines (40 loc) · 2.15 KB

RELEASE.md

File metadata and controls

47 lines (40 loc) · 2.15 KB
Raw

Release process

  1. Create a release commit. This includes specific updated files:

    1. Cargo.toml (Bump the version using semver standards)

    2. Cargo.lock (This is usually updated automatically with the cargo CLI tool)

    3. Make sure the changes for the new release exist under CHANGELOG.md. This should already exist since changes done in GitHub Pull Requests should include updates to the CHANGELOG.md. If this doesn't exist, the release will fail.

    4. Change CHANGELOG.md ## Unreleased to ## [x.x.x] - YYYY-MM-DD where x.x.x is the new Tinty version specified in the Cargo.toml file and the link to [x.x.x] at the bottom of the CHANGELOG.md file and compare it with the previously released version, eg:

      [0.22.0]: https://github.com/tinted-theming/tinty/compare/v0.21.1...v0.22.0

    5. Run cargo about generate about.hbs > LICENSES-THIRD-PARTY.md to update the third party licenses. (cargo install cargo-about if you don't have it installed)

    6. Create a commit with the 3 changed files titled Release x.x.x where x.x.x is the new Tinty version specified in the Cargo.toml file

  2. Push the commit or create a Pull Request and merge

  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