doc: update the release template for git flow changes
Steven Allen committed
May 26, 2020 at 14:22 UTC
e0ea0b369573c009862557770d0e02bb9b267259
1 file changed
+9
-7
docs/RELEASE_ISSUE_TEMPLATE.md
+9
-7
@@ -24,8 +24,8 @@ We're happy to announce go-ipfs X.Y.Z, bla bla...
24
25
For each RC published in each stage:
26
27
-- version string in `version.go` has been updated
28
-- tag commit with vX.Y.Z-rcN
27
+- version string in `version.go` has been updated (in the `release-vX.Y.Z` branch).
28
+- tag commit with `vX.Y.Z-rcN`
29
- upload to dist.ipfs.io
30
1. Build: https://github.com/ipfs/distributions#usage.
31
2. Pin the resulting release.
@@ -39,7 +39,9 @@ For each RC published in each stage:
39
Checklist:
40
41
- [ ] **Stage 0 - Automated Testing**
42
- - [ ] Feature freeze. If any "non-trivial" changes (see the footnotes of [docs/releases.md](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md) for a definition) get added to the release, uncheck all the checkboxes and return to this stage.
42
+ - [ ] Fork a new branch (`release-vX.Y.Z`) from `master` and make any further release related changes to this branch. If any "non-trivial" changes (see the footnotes of [docs/releases.md](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md) for a definition) get added to the release, uncheck all the checkboxes and return to this stage.
43
+ - [ ] Follow the RC release process to cut the first RC.
44
+ - [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`.
45
- [ ] Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes:
46
- [ ] unit, sharness, cross-build, etc (`make test`)
47
- [ ] lint (`make test_go_lint`)
@@ -79,9 +81,9 @@ Checklist:
81
- [ ] IRC
82
- [ ] **Stage 4 - Release**
83
- [ ] Final preparation
82
- - [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated
83
- - [ ] tag commit with vX.Y.Z
84
- - [ ] update release branch to point to release commit (`git merge vX.Y.Z`).
84
+ - [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated.
85
+ - [ ] Merge `release-vX.Y.Z` into the `release` branch.
86
+ - [ ] Tag this merge commit (on the `release` branch) with `vX.Y.Z`.
87
- [ ] Release published
88
- [ ] to [dist.ipfs.io](https://dist.ipfs.io)
89
- [ ] to [npm-go-ipfs](https://github.com/ipfs/npm-go-ipfs)
@@ -98,7 +100,7 @@ Checklist:
100
- [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements)
101
- [ ] Announce it on the [IPFS Users Mailing List](https://groups.google.com/forum/#!forum/ipfs-users)
102
- [ ] **Post-Release**
101
- - [ ] Bump the version in `version.go` to `vX.(Y+1).0-dev`.
103
+ - [ ] Merge the `release` branch back into `master`, ignoring the changes to `version.go` (keep the `-dev` version from master).
104
- [ ] Create an issue using this release issue template for the _next_ release.
105
- [ ] Make sure any last-minute changelog updates from the blog post make it back into the CHANGELOG.
106