From e0ea0b369573c009862557770d0e02bb9b267259 Mon Sep 17 00:00:00 2001 From: Steven Allen Date: Tue, 26 May 2020 14:22:28 -0700 Subject: [PATCH] doc: update the release template for git flow changes --- docs/RELEASE_ISSUE_TEMPLATE.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/RELEASE_ISSUE_TEMPLATE.md b/docs/RELEASE_ISSUE_TEMPLATE.md index 33fb815d015..2e8774eaf4f 100644 --- a/docs/RELEASE_ISSUE_TEMPLATE.md +++ b/docs/RELEASE_ISSUE_TEMPLATE.md @@ -24,8 +24,8 @@ We're happy to announce go-ipfs X.Y.Z, bla bla... For each RC published in each stage: -- version string in `version.go` has been updated -- tag commit with vX.Y.Z-rcN +- version string in `version.go` has been updated (in the `release-vX.Y.Z` branch). +- tag commit with `vX.Y.Z-rcN` - upload to dist.ipfs.io 1. Build: https://github.com/ipfs/distributions#usage. 2. Pin the resulting release. @@ -39,7 +39,9 @@ For each RC published in each stage: Checklist: - [ ] **Stage 0 - Automated Testing** - - [ ] 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. + - [ ] 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. + - [ ] Follow the RC release process to cut the first RC. + - [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`. - [ ] Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes: - [ ] unit, sharness, cross-build, etc (`make test`) - [ ] lint (`make test_go_lint`) @@ -79,9 +81,9 @@ Checklist: - [ ] IRC - [ ] **Stage 4 - Release** - [ ] Final preparation - - [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated - - [ ] tag commit with vX.Y.Z - - [ ] update release branch to point to release commit (`git merge vX.Y.Z`). + - [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated. + - [ ] Merge `release-vX.Y.Z` into the `release` branch. + - [ ] Tag this merge commit (on the `release` branch) with `vX.Y.Z`. - [ ] Release published - [ ] to [dist.ipfs.io](https://dist.ipfs.io) - [ ] to [npm-go-ipfs](https://github.com/ipfs/npm-go-ipfs) @@ -98,7 +100,7 @@ Checklist: - [ ] [discuss.ipfs.io](https://discuss.ipfs.io/c/announcements) - [ ] Announce it on the [IPFS Users Mailing List](https://groups.google.com/forum/#!forum/ipfs-users) - [ ] **Post-Release** - - [ ] Bump the version in `version.go` to `vX.(Y+1).0-dev`. + - [ ] Merge the `release` branch back into `master`, ignoring the changes to `version.go` (keep the `-dev` version from master). - [ ] Create an issue using this release issue template for the _next_ release. - [ ] Make sure any last-minute changelog updates from the blog post make it back into the CHANGELOG.