@@ -674,10 +674,20 @@ Then, a new release can be created using the script
674
674
part):
675
675
676
676
``` shell
677
- build_scripts/release-version.sh v0 .1.6
677
+ build_scripts/release-version.sh 0 .1.6
678
678
```
679
+ This will:
679
680
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:
681
691
682
692
``` shell
683
693
build_scripts/release-version.sh --help
@@ -687,11 +697,10 @@ If running in interactive mode (without `-y|--yes`), the script will output a
687
697
summary of pending changes and ask for confirmation before executing the
688
698
actions.
689
699
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
692
701
[ 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.
695
704
696
705
### Manual release process
697
706
0 commit comments