1
1
# Release tools
2
2
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
+
3
9
## Install requirements
4
10
5
11
### Python 3
6
12
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.
8
14
9
15
Install required packages:
10
16
@@ -18,7 +24,7 @@ Optionally, if you want to have a GitHub Pull-Request automatically created, you
18
24
19
25
To make a release pull-request, go to the folder containing a Cargo workspace or crate and run:
20
26
21
- release.sh release
27
+ release.sh [ release]
22
28
23
29
To bump the version and create pull-request:
24
30
@@ -47,13 +53,13 @@ The release process performs the following steps:
47
53
2 . Update ` Cargo.lock ` with the new version.
48
54
3 . Regenerate Helm chart and manifests.
49
55
4 . 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 .
51
57
6 . __ Optional__ : if the GitHub cli is installed, a PR is created.
52
58
53
59
Raising the next development version includes the following steps:
54
60
0 . Create a release branch from ` main ` .
55
61
1 . Set the version to the next development version by increasing the 'next-devel-level' (by default) part and adding the '-nightly' prerelease token.
56
62
2 . Update ` Cargo.lock ` with the new version.
57
63
3 . Regenerate Helm chart and manifests.
58
- 4 . Commit and push
64
+ 4 . Commit and push * BUT * do not push the tags.
59
65
5 . __ Optional__ : if the GitHub cli is installed, a PR is created.
0 commit comments