Skip to content

Commit da85268

Browse files
committed
[skip ci] Minor improvements to doc for release-version.sh
1 parent 1462af6 commit da85268

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -674,10 +674,20 @@ Then, a new release can be created using the script
674674
part):
675675

676676
```shell
677-
build_scripts/release-version.sh v0.1.6
677+
build_scripts/release-version.sh 0.1.6
678678
```
679+
This will:
679680

680-
To find out how to use the script, pass the `-h` or `--help` flags:
681+
- Pull latest remote version of develop (fast-forward only) from origin
682+
- Create a branch `release/v0.1.6`
683+
- Bump version number: 0.1.5.dev1234 ⟶ 0.1.6
684+
- Merge release branch into master locally and on origin
685+
- Tag as `v0.1.6`
686+
- Bump version number again to next development pre-release
687+
- Merge release branch into develop locally and on origin
688+
- Delete release branch
689+
690+
For usage details, pass the `-h` or `--help` flags:
681691

682692
```shell
683693
build_scripts/release-version.sh --help
@@ -687,11 +697,10 @@ If running in interactive mode (without `-y|--yes`), the script will output a
687697
summary of pending changes and ask for confirmation before executing the
688698
actions.
689699

690-
Once this is done, a tag will be created on the repository. You should then
691-
create a GitHub
700+
Once the script is done, you should then create a GitHub
692701
[release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)
693-
for that tag. That will a trigger a CI pipeline that will automatically create a
694-
package and publish it from CI to PyPI.
702+
for the tag that was created. That will a trigger a CI pipeline that will
703+
automatically create a package and publish it from CI to PyPI.
695704

696705
### Manual release process
697706

build_scripts/release-version.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Usage:
3939
-r, --remote <remote> The remote on which to release, default is origin
4040
4141
Positional options:
42-
VERSION_STR Version to release, e.g. v0.1.2.
42+
VERSION_STR Version to release, e.g. 0.1.2 (tag will be v0.1.2)
4343
If not specified, 'bumpversion' is used to determine release version number.
4444
4545
Prerequisites:

0 commit comments

Comments
 (0)