@cryptotaxi247 / kubo / commits / c86b75deb

docs: move changelog creation instructions earlier

galargh committed Sep 27, 2022 at 17:08 UTC c86b75debde670c08599e0229195ed3bf93ca8dd
1 file changed +10 -5
docs/RELEASE_ISSUE_TEMPLATE.md
+10 -5
@@ -44,6 +44,11 @@ Checklist:
44 - [ ] Access to [#bifrost](https://filecoinproject.slack.com/archives/C03MMMF606T) channel in FIL Slack might come in handy. Ask the release reviewer to invite you over.
45 - [ ] After the release is deployed to our internal infrastructure, you're going to need read access to [IPFS network metrics](https://github.com/protocol/pldw/blob/624f47cf4ec14ad2cec6adf601a9f7b203ef770d/docs/sources/ipfs.md#ipfs-network-metrics) dashboards. Open an access request in https://github.com/protocol/pldw/issues/new/choose if you don't have it yet ([example](https://github.com/protocol/pldw/issues/158)).
46 - [ ] You're also going to need NPM installed on your system. See [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for instructions.
47 + - [ ] Prepare changelog proposal in [docs/changelogs/vX.Y.md](docs/changelogs).
48 + - Skip filling out the `### Changelog` section (the one where which lists all the commits and contributors) for now. We will populate it after the release branch is cut.
49 + - [ ] Install ZSH ([instructions](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#install-and-set-up-zsh-as-default)). It is needed by the changelog creation script.
50 + - [ ] Ensure you have `kubo` checked out under `$(go env GOPATH)/src/github.com/ipfs/kubo`. This is required by the changelog creation script.
51 + - If you want your clone to live in a different location, you can symlink it to the expected location by running `mkdir -p $(go env GOPATH)/src/github.com/ipfs && ln -s $(pwd) $(go env GOPATH)/src/github.com/ipfs/kubo`.
52 - [ ] **Stage 1 - Initial Preparations**
53 - [ ] Upgrade to the latest patch release of Go that CircleCI has published (currently used version: `1.19.1`)
54 - [ ] See the list here: https://hub.docker.com/r/cimg/go/tags
@@ -55,6 +60,11 @@ Checklist:
60 - [ ] Bump the version in `version.go` in the `release-vX.Y.Z` branch to `vX.Y.Z-rcN`.
61 - [ ] If applicable, add new commits to the `release-vX.Y.Z` branch from `master` using `git cherry-pick -x ...`
62 - Note: `release-*` branches are protected. You can do all needed updates on a separated branch (e.g. `wip-release-vX.Y.Z`) and when everything is settled push to `release-vX.Y.Z`
63 + - [ ] Update the [docs/changelogs/vX.Y.md](docs/changelogs) with the new commits and contributors.
64 + - [ ] Run `./bin/mkreleaselog` twice to generate the changelog and copy the output.
65 + - The first run of the script might be poluted with `git clone` output.
66 + - [ ] Paste the output into the `### Changelog` section of the changelog file inside the `<details><summary></summary></details>` block.
67 + - [ ] Commit the changelog changes.
68 - [ ] Push the `release-vX.Y.Z` branch to GitHub (`git push origin release-vX.Y.Z`) and create a draft PR from that branch if it doesn't exist yet ([example](https://github.com/ipfs/kubo/pull/9306)).
69 - [ ] Wait for CI to run and complete PR checks. All checks should pass.
70 - [ ] Tag HEAD `release-vX.Y.Z` commit with `vX.Y.Z-rcN` (`git tag -s vX.Y.Z-rcN`, use "Pre-release 0.15.0-rc1" as the tag message)
@@ -125,11 +135,6 @@ Checklist:
135 - [ ] Run [CI workflow](https://github.com/ipfs/ipfs-webui/actions/workflows/ci.yml) with `vX.Y.Z-rcN` for the `kubo-version` input.
136 - [ ] Ensure that CI is green.
137 - [ ] **Stage 4 - Community Prod Testing** - _ONLY FOR FINAL RELEASE_
128 - - [ ] Documentation
129 - - [ ] Ensure that [CHANGELOG.md](https://github.com/ipfs/go-ipfs/tree/master/CHANGELOG.md) is up to date
130 - - [ ] CHANGELOG.md has been updated // This is only relevant for final release
131 - - use [`./bin/mkreleaselog`](https://github.com/ipfs/go-ipfs/tree/master/bin/mkreleaselog) to generate a nice starter list
132 - - you need to install `zsh`.
138 - [ ] Add a link from release notes to Discuss post (like we did here: https://github.com/ipfs/kubo/releases/tag/v0.15.0 )
139 - [ ] Keep the release notes as trim as possible (removing some of the top headers, like we did here: https://github.com/ipfs/kubo/releases/tag/v0.15.0 )
140 - [ ] Ensure that [README.md](https://github.com/ipfs/go-ipfs/tree/master/README.md) is up to date