11# Release tools
22
3+ A set of scripts that automates some release steps. Rougly the release process has three steps:
4+
5+ 1 . Create a release pull-request containing one commit.
6+ 2 . Push the release tag manually (` git push --tags ` ). Intended to be done after the first step has been merged,
7+ 3 . Optional: create a * next development version* pull-request.
8+
39## Install requirements
410
511### Python 3
612
7- A working python 3 installation is required by the cargo-version.py script.
13+ A working python 3 installation is required by the ` cargo-version.py ` script.
814
915Install required packages:
1016
@@ -18,7 +24,7 @@ Optionally, if you want to have a GitHub Pull-Request automatically created, you
1824
1925To make a release pull-request, go to the folder containing a Cargo workspace or crate and run:
2026
21- release.sh release
27+ release.sh [ release]
2228
2329To bump the version and create pull-request:
2430
@@ -47,13 +53,13 @@ The release process performs the following steps:
47532 . Update ` Cargo.lock ` with the new version.
48543 . Regenerate Helm chart and manifests.
49554 . Update the CHANGELOG.md entry of this release
50- 5 . Commit, tag and push the changes.
56+ 5 . Commit, tag and push the changes * BUT * do not push the tags .
51576 . __ Optional__ : if the GitHub cli is installed, a PR is created.
5258
5359Raising the next development version includes the following steps:
54600 . Create a release branch from ` main ` .
55611 . Set the version to the next development version by increasing the 'next-devel-level' (by default) part and adding the '-nightly' prerelease token.
56622 . Update ` Cargo.lock ` with the new version.
57633 . Regenerate Helm chart and manifests.
58- 4 . Commit and push
64+ 4 . Commit and push * BUT * do not push the tags.
59655 . __ Optional__ : if the GitHub cli is installed, a PR is created.
0 commit comments