Skip to content

Commit b2c000d

Browse files
authored
Merge pull request #2082 from CecileRobertMichon/release-action-tag
Update book release instructions for 1.x releases
2 parents d8cf282 + 974d172 commit b2c000d

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/book/src/developers/releasing.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@
99

1010
## Create a tag
1111

12-
- Identify a known good commit on the main branch
13-
- Fast-forward the release branch to the selected commit. :warning: Always release from the release branch and not from main!
14-
- `git checkout release-0.x`
15-
- `git fetch upstream`
16-
- `git merge --ff-only upstream/main`
17-
- `git push`
12+
- Prepare the release branch. :warning: Always release from the release branch and not from main!
13+
- If releasing a patch release, check out the existing release branch and make sure you have the latest changes:
14+
- `git checkout release-1.x`
15+
- `git fetch upstream`
16+
- `git rebase upstream/release-1.x`
17+
- If releasing a minor release, create a new release branch from the main branch:
18+
- `git fetch upstream`
19+
- `git rebase upstream/main`
20+
- `git checkout -b release-1.x`
21+
- `git push upstream release-1.x`
1822
- Create tag with git
19-
- `export RELEASE_TAG=v0.4.6` (the tag of the release to be cut)
23+
- `export RELEASE_TAG=v1.2.3` (the tag of the release to be cut)
2024
- `git tag -s ${RELEASE_TAG} -m "${RELEASE_TAG}"`
2125
- `-s` creates a signed tag, you must have a GPG key [added to your GitHub account](https://docs.github.com/en/enterprise/2.16/user/github/authenticating-to-github/generating-a-new-gpg-key)
2226
- `git push upstream ${RELEASE_TAG}`

0 commit comments

Comments
 (0)