docs: release process updates from v0.17.0 #9391
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <!-- Last updated by @galargh during [0.17.0 release](https://github.com/ipfs/kubo/issues/9319) --> | ||
|
|
||
| > Release Issue Template. If doing a patch release, see [here](https://github.com/ipfs/kubo/blob/master/docs/PATCH_RELEASE_TEMPLATE.md) | ||
|
|
||
|
|
@@ -14,7 +14,7 @@ | |
| * Release reviewer: @who | ||
| * Expected RC date: week of YYYY-MM-DD | ||
| * 🚢 Expected final release date: YYYY-MM-DD | ||
| * Accompanying PR for improving the release process: (example: https://github.com/ipfs/kubo/pull/9391) | ||
|
|
||
| See the [Kubo release process](https://pl-strflt.notion.site/Kubo-Release-Process-5a5d066264704009a28a79cff93062c4) for more info. | ||
|
|
||
|
|
@@ -41,11 +41,13 @@ As usual, this release includes important fixes, some of which may be critical f | |
| Checklist: | ||
|
|
||
| - [ ] **Stage 0 - Prerequisites** | ||
| - [ ] Open an issue against [bifrost-infra](https://github.com/protocol/bifrost-infra) ahead of the release ([example](https://github.com/protocol/bifrost-infra/issues/2109)). **Idealy, do this multiple days in advance of the RC** to give Bifrost the heads up that asks will be coming their way. | ||
| - [ ] Spell out all that we want updated - gateways, the bootstraper and the cluster/preload nodes | ||
| - [ ] Mention @protocol/bifrost-team in the issue and let them know the expected date of the release | ||
| - Issue link: | ||
| - [ ] Ensure that the `What's left for release` section has all the checkboxes checked. If that's not the case, discuss the open items with Kubo maintainers and update the release schedule accordingly. | ||
| - [ ] Create `docs-release-vX.Y.Z` branch, open a draft PR and keep updating `docs/RELEASE_ISSUE_TEMPLATE.md` on that branch as you go. | ||
| - [ ] Link it in the "Meta" section above. | ||
| - [ ] Ensure you have a [GPG key generated](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) and [added to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). This will enable you to created signed tags. | ||
| - [ ] Ensure you have [admin access](https://discuss.ipfs.tech/g/admins) to [IPFS Discourse](https://discuss.ipfs.tech/). Admin access is required to globally pin posts and create banners. @2color might be able to assist you. | ||
| - [ ] 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. | ||
|
|
@@ -54,6 +56,8 @@ Checklist: | |
| - [ ] 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. | ||
| - [ ] Prepare changelog proposal in [docs/changelogs/vX.Y.md](https://github.com/ipfs/kubo/blob/master/docs/changelogs/). | ||
| - 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. | ||
| - PR link: | ||
| - [ ] Ensure the new changelog is linked in the [CHANGELOG.md](CHANGELOG.md) file. | ||
| - [ ] 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. | ||
| - [ ] Ensure you have `kubo` checked out under `$(go env GOPATH)/src/github.com/ipfs/kubo`. This is required by the changelog creation script. | ||
| - 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`. | ||
|
|
@@ -63,25 +67,25 @@ Checklist: | |
| - [ ] See the list here: https://hub.docker.com/r/cimg/go/tags | ||
| - [ ] [ipfs/distributions](https://github.com/ipfs/distributions): bump [this version](https://github.com/ipfs/distributions/blob/master/.tool-versions#L2) | ||
| - [ ] [ipfs/kubo](https://github.com/ipfs/kubo): [example PR](https://github.com/ipfs/kubo/pull/8599) | ||
| - [ ] [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs): [example PR](https://github.com/ipfs/ipfs-docs/pull/1298) - only if the major version changed | ||
| - [ ] Fork a new branch (`release-vX.Y.Z`) from `master`. | ||
| - [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev` via a PR ([example](https://github.com/ipfs/kubo/pull/9305)). | ||
| - [ ] **Stage 2 - Release Candidate** - _if any [non-trivial](docs/releases.md#footnotes) changes need to be included in the release, return to this stage_ | ||
| - [ ] If it's not a first RC, add new commits to the `release-vX.Y.Z` branch from `master` using `git cherry-pick -x ...` | ||
| - 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` | ||
| - [ ] Bump the version in `version.go` in the `release-vX.Y.Z` branch to `vX.Y.Z-rcN`. | ||
| - [ ] If it's a first RC, create a draft PR targetting `release` branch if it doesn't exist yet ([example](https://github.com/ipfs/kubo/pull/9306)). | ||
| - [ ] Wait for CI to run and complete PR checks. All checks should pass. | ||
| - [ ] Create a signed tag for the release candidate. | ||
| - [ ] This is a dangerous operation, as it is difficult to reverse due to Go modules and automated Docker image publishing. Remember to verify the commands you intend to run for items marked with ⚠️ with the release reviewer. | ||
| - [ ] ⚠️ Tag HEAD `release-vX.Y.Z` commit with `vX.Y.Z-rcN` (`git tag -s vX.Y.Z-rcN -m 'Pre-release X.Y.Z-rcn'`) | ||
| - [ ] Run `git show vX.Y.Z-rcN` to ensure the tag is correct. | ||
| - [ ] ⚠️ Push the `vX.Y.Z-rcN` tag to GitHub (`git push origin vX.Y.Z-rcN`; DO NOT USE `git push --tags` because it pushes all your local tags). | ||
| - [ ] Add artifacts to https://dist.ipfs.tech by making a PR against [ipfs/distributions](https://github.com/ipfs/distributions) | ||
| - [ ] Clone the `ipfs/distributions` repo locally. | ||
| - [ ] Create a new branch (`kubo-release-vX.Y.Z-rcn`) from `master`. | ||
| - [ ] Run `./dist.sh add-version kubo vX.Y.Z-rcN` to add the new version to the `versions` file ([instructions](https://github.com/ipfs/distributions#usage)). | ||
| - `dist.sh` will print _WARNING: not marking pre-release kubo vX.Y.Z-rcN as the current version._. | ||
| - [ ] Push the `kubo-release-vX.Y.Z-rcn` branch to GitHub and create a PR from that branch ([example](https://github.com/ipfs/distributions/pull/760)). | ||
| - [ ] Ask for a review from the release reviewer. | ||
| - [ ] Enable auto-merge for the PR. | ||
|
|
@@ -90,7 +94,7 @@ Checklist: | |
| - `master` build will publish the artifacts to https://dist.ipfs.io in around 30 minutes | ||
| - [ ] Ensure that the artifacts are available at https://dist.ipfs.io | ||
| - [ ] Publish the RC to [the NPM package](https://www.npmjs.com/package/go-ipfs?activeTab=versions) by running https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml (it happens automatically but it is safe to speed up the process and kick of a run manually) | ||
| - [ ] Cut a pre-release on [GitHub](https://github.com/ipfs/kubo/releases) ([instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1)) | ||
| - Use `vX.Y.Z-rcN` as the tag. | ||
| - Link to the release issue in the description. | ||
| - Link to the relevant [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/) in the description. | ||
|
|
@@ -108,26 +112,8 @@ Checklist: | |
| - [ ] IPFS Discord #ipfs-chatter | ||
| - [ ] FIL Slack #ipfs-chatter | ||
| - [ ] Matrix https://matrix.to/#/#ipfs-chatter:ipfs.io | ||
| - [ ] Mention [early testers](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md) in the comment under the release issue ([example](https://github.com/ipfs/kubo/issues/9319#issuecomment-1311002478)). | ||
|
There was a problem hiding this comment. I updated the link because in the latest comment I added context for why folks were being pinged and how they get removed. For example, while @b5 is still absolutely in the community, QRI is no-more and I don't think need to be pinged about Kubo releases. |
||
| - [ ] **Stage 3 - Internal Testing** | ||
|
There was a problem hiding this comment. We test these in Kubo CI. |
||
| - [ ] Infrastructure Testing. | ||
| - [ ] Update the issue against [bifrost-infra](https://github.com/protocol/bifrost-infra) ([example](https://github.com/protocol/bifrost-infra/issues/2109)). | ||
| - [ ] Mention @protocol/bifrost-team in the issue to let them know the release is ready | ||
|
|
@@ -150,7 +136,7 @@ Checklist: | |
| - [ ] Check that the comunication between Kubo daemon and IPFS companion is working properly checking if the number of connected peers changes. | ||
| - [ ] **Stage 5 - Release** - _ONLY FOR FINAL RELEASE_ | ||
| - [ ] Prepare the `release` branch. | ||
| - [ ] Bump the version in `version.go` in the `release-vX.Y.Z` branch to `X.Y.Z`. | ||
| - [ ] Update the [docs/changelogs/vX.Y.md](docs/changelogs) with the new commits and contributors. | ||
| - [ ] Run `./bin/mkreleaselog` twice to generate the changelog and copy the output. | ||
| - The first run of the script might be poluted with `git clone` output. | ||
|
|
@@ -184,12 +170,12 @@ Checklist: | |
| - `master` build will publish the artifacts to https://dist.ipfs.io in around 30 minutes | ||
| - [ ] Ensure that the artifacts are available at https://dist.ipfs.io | ||
| - [ ] Publish the release to [the NPM package](https://www.npmjs.com/package/go-ipfs?activeTab=versions) by running https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml (it happens automatically but it is safe to speed up the process and kick of a run manually) | ||
| - [ ] Cut the release on [GitHub](https://github.com/ipfs/kubo/releases) ([instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)) | ||
| - Use `vX.Y.Z` as the tag. | ||
| - Copy the relevant [changelog](https://github.com/ipfs/kubo/blob/release/docs/changelogs/) into the release description. | ||
| - Keep the release notes as trim as possible (e.g. remove top headers where possible, [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)) | ||
| - [ ] Synchronize release artifacts by running [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow. | ||
| - [ ] TODO: https://github.com/protocol/bifrost-infra/issues/2184#issuecomment-1315279257 | ||
| - [ ] Announce the release | ||
| - [ ] Add a link to the release to this release issue as a comment. | ||
| - [ ] Create a new post on [IPFS Discourse](https://discuss.ipfs.tech). ([example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15286)) | ||
|
|
@@ -203,19 +189,21 @@ Checklist: | |
| - [ ] IPFS Discord #ipfs-chatter | ||
| - [ ] FIL Slack #ipfs-chatter | ||
| - [ ] Matrix | ||
| - [ ] Add a link from release notes to Discuss post (like we did here: https://github.com/ipfs/kubo/releases/tag/v0.17.0) | ||
| - [ ] Update the draft PR created for [interop](https://github.com/ipfs/interop) to use the new release and mark it as ready for review. | ||
| - [ ] Update the draft PR created for [IPFS Desktop](https://github.com/ipfs-shipyard/ipfs-desktop) to use the new release and mark it as ready for review. | ||
| - [ ] Update docs | ||
| - [ ] Run https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml to generate a PR to the docs repo | ||
| - [ ] Merge the auto-created PR in https://github.com/ipfs/ipfs-docs/pulls ([example](https://github.com/ipfs/ipfs-docs/pull/1263)) | ||
| - [ ] Get the blog post created | ||
|
There was a problem hiding this comment. There is no way to link to the blogpost as it's just a redirect to the GitHub release. |
||
| - [ ] Submit a request for blog post creation using [the form](https://airtable.com/shrNH8YWole1xc70I). | ||
| - Title: Just released: Kubo X.Y.Z! | ||
| - Link type: Release notes | ||
| - URL: https://github.com/ipfs/kubo/releases/tag/vX.Y.Z | ||
| - [ ] The post is live on https://blog.ipfs.io | ||
| - [ ] Share the link to the GitHub release | ||
| - [ ] Twitter (request in Filecoin Slack channel #shared-pl-marketing-requests; [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664903524843269?thread_ts=1664885305.374909&cid=C018EJ8LWH1)) | ||
| - [ ] [Reddit](https://reddit.com/r/ipfs) | ||
| - [ ] **Stage 6 - Post-Release** | ||
| - [ ] 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. | ||
|
|
@@ -226,7 +214,5 @@ Checklist: | |
| Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started: | ||
|
|
||
| - Check the issues with the `help wanted` label in the [ipfs/kubo repo](https://github.com/ipfs/kubo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) | ||
| - Join the discussion at [discuss.ipfs.tech](https://discuss.ipfs.tech/) and help users finding their answers. | ||
| - See other options at https://docs.ipfs.tech/community/ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am linking to this PR because we'll use it to set the right template in terms of PR title and description.