Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 867 Bytes

RELEASE.md

File metadata and controls

26 lines (17 loc) · 867 Bytes

Releasing fishy

This is an example for publising version 1.2.0.

Checks and preparations

  1. Make sure you are on the main branch.

Changelog time!

  1. Check the git history for any commits on main that have not been mentioned in the Unreleased section of CHANGELOG.md but should be.
  2. Add an entry in CHANGELOG.md for this new release and move over all the Unreleased stuff. Follow the formatting given by previous entries.

Tagging and versioning

  1. Bump the package version in Cargo.toml by hand.
  2. Commit the version changes with a commit message 1.2.0.
  3. Run git tag v1.2.0 and push including your tags using git push origin main --tags.

Publishing releases

  1. The GitHub Action will automatically create the release on GitHub, compile binary targets and upload them as assets. Check if the jobs succeeded.