Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.23 KB

RELEASE.md

File metadata and controls

29 lines (18 loc) · 1.23 KB
Raw

Releasing aquadoggo

This is an example for publising version 1.2.0.

Checks and preparations

  1. Check that the CI has passed on the aquadoggo project's Github page.
  2. Make sure you are on the main branch.
  3. Run the test suites and make sure all tests pass: cargo test.

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, also bump the aquadoggo dependency version in aquadoggo_cli.
  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.
  2. Run cargo publish.

Publishing on DockerHub

  1. The GitHub Action will automatically release this version on DockerHub based on the given Git Tag.