scripts/RELEASE.md
Check out main and ensure you're on the latest commit
git checkout main
git pull
First, prepare a PR (or push) version bump for all submodules!
Run the release script with the current repository version and the version being released. Both arguments are required:
python3 ./scripts/make-release.py OLD_VERSION RELEASE_VERSION
For example:
python3 ./scripts/make-release.py 6.0.1 6.1.0
Wait for the script to open a PR and note the PR branch name.
Check out the PR branch:
git checkout <release-branch>
Update the auto-generated CHANGELOG.md:
Commit and push your changes.
Wait for CI to pass and merge the PR into main.
The make-release.py script automatically monitors the PR and both tags the release and properly publishes artifacts. Plus, a new draft release is created as well.
Open the draft release, add a meaningful description (often the CHANGELOG summary), and publish it.
Locally, check out the release tag and publish the crates:
git checkout v6.1.0
python3 ./scripts/publish.py publish
š Release complete!