Skip to content

RELEASING.md

Latest commit

 

History

History
13 lines (10 loc) · 1.02 KB

RELEASING.md

File metadata and controls

13 lines (10 loc) · 1.02 KB
Raw

Releasing

Note: requires Docker.

Note: If you need to do a release from your local machine for some reason, you need to deactivate(comment out or remove) the release workflow trigger from the workflow definition. Once this has been committed and pushed, you can follow all the release steps below and run make release locally at the end.

  1. Update the CHANGELOG.md file with a new entry describing the latest changes up to the version of the release
  2. Commit the previous steps' changes with a message Prepare release
  3. Make sure you have the latest git tags: git fetch --tags
  4. Run make git-tag and select the appropriate version
  5. Run git push to push your commit
  6. Run git push --tags to push the tag you just created. This will trigger the release GitHub Action workflow. Once it has completed successfully, the release is done.