Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.02 KB

RELEASING.md

File metadata and controls

34 lines (22 loc) · 1.02 KB
Raw

Releasing

Releasing checklist:

(1) Write a changelog.

(2) Run version bump script with the new version as an argument and open a PR.

python scripts/update_version.py v0.5.1

(3) Create and push a release branch.

git checkout -b release-v0.5.1
git push release-v0.5.1

(4) Checkout the branch to be released. This should be main except in the event of a hotfix. For hotfixes, checkout the latest release branch.

(5) Create a tag for the release.

git tag v0.5.1

(6) Push the tag to the main repository, triggering the CI and release process.

git push origin v0.5.1

(7) Finally, go to the repo's releases page and create a new one with the new tag and the base branch as target (which should be main except in the event of a hotfix).