Skip to content

Commit 839f0bc

Browse files
authored
Do not push release tags automatically anymore. (#25)
1 parent 3d92093 commit 839f0bc

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

release/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
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

915
Install required packages:
1016

@@ -18,7 +24,7 @@ Optionally, if you want to have a GitHub Pull-Request automatically created, you
1824

1925
To 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

2329
To bump the version and create pull-request:
2430

@@ -47,13 +53,13 @@ The release process performs the following steps:
4753
2. Update `Cargo.lock` with the new version.
4854
3. Regenerate Helm chart and manifests.
4955
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.
5157
6. __Optional__: if the GitHub cli is installed, a PR is created.
5258

5359
Raising the next development version includes the following steps:
5460
0. Create a release branch from `main`.
5561
1. Set the version to the next development version by increasing the 'next-devel-level' (by default) part and adding the '-nightly' prerelease token.
5662
2. Update `Cargo.lock` with the new version.
5763
3. Regenerate Helm chart and manifests.
58-
4. Commit and push
64+
4. Commit and push *BUT* do not push the tags.
5965
5. __Optional__: if the GitHub cli is installed, a PR is created.

release/release.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ main() {
8080

8181
if [ "$PUSH" = "true" ]; then
8282
git push ${REPOSITORY} ${RELEASE_BRANCH}
83-
git push --tags
83+
# git push --tags
8484
maybe_create_github_pr $MESSAGE
8585
git switch main
8686
fi

0 commit comments

Comments
 (0)