Skip to content

Commit e1fa0b6

Browse files
committed
Fix the new release process
1 parent 562cb81 commit e1fa0b6

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

.github/ISSUE_TEMPLATE/minor_release.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ assignees: ''
2121

2222
<--add notices from PRs merged since the prior release, see ["keep a changelog"]-->
2323

24-
### Checklist
24+
### Checklist
2525

26-
Release numbering must follow [Semantic Versioning]. These steps assume the current `master`
26+
Release numbering must follow [Semantic Versioning]. These steps assume the current `master`
2727
branch **development** version is *MAJOR.MINOR.0*.
2828

2929
#### On the day of the feature freeze
@@ -37,34 +37,43 @@ Change the `master` branch to the next MINOR+1 version:
3737
- The commit message should be "Bump version to MAJOR.MINOR+1.0".
3838
- [ ] Create PR and merge the `bump_dev_MAJOR_MINOR+1` branch to `master`.
3939
- Title PR "Bump version to MAJOR.MINOR+1.0".
40-
40+
4141
Create a new release branch and release candidate tag:
4242

4343
- [ ] Double check that your local `master` is up-to-date with the upstream repo.
4444
- [ ] Create a new branch called `release/MAJOR.MINOR+1` from `master`.
45+
- [ ] Bump the `release/MAJOR.MINOR+1` branch to `MAJOR.MINOR+1.0-rc.1` version.
46+
- Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0-rc.1`.
47+
- The commit message should be "Bump version to MAJOR.MINOR+1.0-rc.1".
4548
- [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR+1` branch.
46-
- The tag name should be `vMAJOR.MINOR+1.0-RC.1`
47-
- Use message "Release MAJOR.MINOR+1.0 RC.1".
49+
- The tag name should be `vMAJOR.MINOR+1.0-rc.1`
50+
- Use message "Release MAJOR.MINOR+1.0 rc.1".
4851
- Make sure the tag is signed, for extra safety use the explicit `--sign` flag.
4952
- [ ] Push the `release/MAJOR.MINOR` branch and new tag to the `bitcoindevkit/bdk` repo.
50-
- Use `git push --tags` option to push the new `vMAJOR.MINOR+1.0-RC.1` tag.
51-
53+
- Use `git push --tags` option to push the new `vMAJOR.MINOR+1.0-rc.1` tag.
54+
5255
If any issues need to be fixed before the *MAJOR.MINOR+1.0* version is released:
5356

5457
- [ ] Merge fix PRs to the `master` branch.
5558
- [ ] Git cherry-pick fix commits to the `release/MAJOR.MINOR+1` branch.
5659
- [ ] Verify fixes in `release/MAJOR.MINOR+1` branch.
60+
- [ ] Bump the `release/MAJOR.MINOR+1` branch to `MAJOR.MINOR+1.0-rc.x+1` version.
61+
- Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0-rc.x+1`.
62+
- The commit message should be "Bump version to MAJOR.MINOR+1.0-rc.x+1".
5763
- [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR+1` branch.
58-
- The tag name should be `vMAJOR.MINOR+1.0-RC.x+1`, where x is the current release candidate number.
59-
- Use tag message "Release MAJOR.MINOR+1.0 RC.x+1".
64+
- The tag name should be `vMAJOR.MINOR+1.0-rc.x+1`, where x is the current release candidate number.
65+
- Use tag message "Release MAJOR.MINOR+1.0 rc.x+1".
6066
- Make sure the tag is signed, for extra safety use the explicit `--sign` flag.
6167
- [ ] Push the new tag to the `bitcoindevkit/bdk` repo.
62-
- Use `git push --tags` option to push the new `vMAJOR.MINOR+1.0-RC.x+1` tag.
68+
- Use `git push --tags` option to push the new `vMAJOR.MINOR+1.0-rc.x+1` tag.
6369

6470
#### On the day of the release
6571

6672
Tag and publish new release:
6773

74+
- [ ] Bump the `release/MAJOR.MINOR+1` branch to `MAJOR.MINOR+1.0` version.
75+
- Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0`.
76+
- The commit message should be "Bump version to MAJOR.MINOR+1.0".
6877
- [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR+1` branch.
6978
- The tag name should be `vMAJOR.MINOR+1.0`
7079
- The first line of the tag message should be "Release MAJOR.MINOR+1.0".

.github/ISSUE_TEMPLATE/patch_release.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ assignees: ''
2121

2222
<--add notices from PRs merged since the prior release, see ["keep a changelog"]-->
2323

24-
### Checklist
24+
### Checklist
2525

26-
Release numbering must follow [Semantic Versioning]. These steps assume the current `master`
26+
Release numbering must follow [Semantic Versioning]. These steps assume the current `master`
2727
branch **development** version is *MAJOR.MINOR.PATCH*.
2828

2929
### On the day of the patch release
@@ -43,6 +43,9 @@ Cherry-pick, tag and publish new PATCH+1 release:
4343
- [ ] Merge fix PRs to the `master` branch.
4444
- [ ] Git cherry-pick fix commits to the `release/MAJOR.MINOR` branch to be patched.
4545
- [ ] Verify fixes in `release/MAJOR.MINOR` branch.
46+
- [ ] Bump the `release/MAJOR.MINOR.PATCH+1` branch to `MAJOR.MINOR.PATCH+1` version.
47+
- Change the `Cargo.toml` version value to `MAJOR.MINOR.MINOR.PATCH+1`.
48+
- The commit message should be "Bump version to MAJOR.MINOR.PATCH+1".
4649
- [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR` branch.
4750
- The tag name should be `vMAJOR.MINOR.PATCH+1`
4851
- The first line of the tag message should be "Release MAJOR.MINOR.PATCH+1".

0 commit comments

Comments
 (0)