lidel commented 1 month ago

Items In Scope

Required

Nice To Have (Optional)

[ ] libp2p.direct support (TBD)
[ ] Denylist support fixes and improvements
- [ ] https://github.com/ipfs-shipyard/nopfs/issues/40
- [ ] https://github.com/ipfs-shipyard/nopfs/issues/34 (NOfs content filtering is not applied to bitswap)
- [ ] https://github.com/ipfs/rainbow/issues/126 (same applies to Kubo)
- [ ] https://github.com/ipfs/kubo/issues/10361
- [ ] https://github.com/ipfs-shipyard/nopfs/issues/39
- [ ] https://github.com/ipfs-shipyard/nopfs/issues/38
[x] update to new webui with fixes and improvements: https://github.com/ipfs/kubo/pull/10523
[x] https://github.com/ipfs/kubo/pull/10516
[x] https://github.com/libp2p/go-libp2p/pull/2936
[x] https://github.com/libp2p/go-libp2p/pull/2931
[x] https://github.com/ipfs/kubo/pull/10492
[ ] https://github.com/ipfs/kubo/pull/9684 + update to v0.12.0 with GossipSub v1.2
[x] https://github.com/ipfs/kubo/issues/10347
[ ] https://github.com/ipfs/kubo/issues/10331
[x] https://github.com/ipfs/kubo/pull/10517
[ ] https://github.com/ipfs/boxo/pull/665 disabled by default, with opt-in variable similar to this or this
[ ] https://github.com/ipfs/kubo/issues/10513
[x] https://github.com/ipfs/kubo/pull/10520
[ ] https://github.com/ipfs/boxo/issues/673
[x] https://github.com/ipfs/kubo/pull/10524
[x] https://github.com/ipfs/kubo/pull/8661

gammazero commented 5 days ago

✅ Release Checklist (v0.31.0-rc1)

[x] Prepare the release branch and update version numbers accordingly
using ./kuboreleaser --skip-check-before release --version vX.Y.Z(-rcN) prepare-branch or ...
- [x] create a new branch release-vX.Y.Z
- use master as base if Z == 0
- use release as base if Z > 0
- [x] update the CurrentVersionNumber in version.go in the master branch to vX.Y+1.0-dev
- example
- [x] update the CurrentVersionNumber in version.go in the release-vX.Y branch to vX.Y.Z(-RCN)
- example
- [x] create a draft PR from release-vX.Y to release
- example
- [ ] Cherry-pick commits from master to the release-vX.Y.Z using git cherry-pick -x <commit>
- [ ] Add full changelog and contributors to the changelog
- [ ] Replace the Changelog and Contributors sections of the changelog with the stdout of ./bin/mkreleaselog. Note that the command expects your $GOPATH/src/github.com/ipfs/kubo to include latest commits from release-vX.Y
  - do NOT copy the stderr
- [x] verify all CI checks on the PR from release-vX.Y to release are passing
- [ ] Merge the PR from release-vX.Y to release using the Create a merge commit
- do NOT use Squash and merge nor Rebase and merge because we need to be able to sign the merge commit
- do NOT delete the release-vX.Y branch

[x] Create the release tag

using ./kuboreleaser release --version vX.Y.Z(-rcN) tag or ...

This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
[x] ⚠️ tag the HEAD commit using git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'
[x] ⚠️ tag the HEAD commit of the release branch using git tag -s vX.Y.Z -m 'Release X.Y.Z'
[x] ⚠️ verify the tag is signed and tied to the correct commit using git show vX.Y.Z(-RCN)
[x] ⚠️ push the tag to GitHub using git push origin vX.Y.Z(-RCN)
do NOT use git push --tags because it pushes all your local tags

[x] Verify ipfs/distributions's .tool-versions's golang entry is set to the latest go release on the major go branch Kubo is being tested on (see go-version:).

[x] Publish to Dockerhub, NPM, and dist.ipfs.tech and GitHub using ./kuboreleaser --skip-check-before --skip-run release --version vX.Y.Z(-rcN) publish-to-all or follow each step below:

[x] Publish the release to DockerHub
using ./kuboreleaser --skip-check-before --skip-run release --version vX.Y.Z(-rcN) publish-to-dockerhub or ...
[x] Wait for Publish docker image workflow run initiated by the tag push to finish
[x] verify the image is available on Docker Hub
[x] Publish the release to dist.ipfs.tech
using ./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-distributions or ...
[x] check out ipfs/distributions
[x] run ./dist.sh add-version kubo vX.Y.Z(-RCN) to add the new version to the versions file
- usage
[x] create and merge the PR which updates dists/kubo/versions and dists/go-ipfs/versions ( and dists/kubo/current_version and dists/go-ipfs/current_version)
- example
[x] wait for the CI workflow run initiated by the merge to master to finish
[x] verify the release is available on dist.ipfs.tech
[x] Publish the release to NPM
using ./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-npm (⚠️ you might need to run the command a couple of times because GHA might not be able to see the new distribution straight away due to caching) or ...
[x] run the Release to npm workflow
[x] check Release to npm workflow run logs to verify it discovered the new release
[x] verify the release is available on NPM
[x] Publish the release to GitHub
using ./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-github or ...
[x] create a new release on GitHub
- RC example
- FINAL example
- [x] use the vX.Y.Z(-RCN) tag
- [x] link to the release issue
- [x] link to the changelog in the description
- [x] check the This is a pre-release checkbox
- [ ] copy the changelog (without the header) in the description
- [ ] do NOT check the This is a pre-release checkbox
[x] run the sync-release-assets workflow
[x] wait for the sync-release-assets workflow run to finish
[x] verify the release assets are present in the GitHub release

[x] Update Kubo staging environment, see the Running Kubo tests on staging for details.

[x] Test last release against the current RC
[ ] Test last release against the current one

[x] Promote the release

using ./kuboreleaser release --version vX.Y.Z(-rcN) promote or ...

[x] create an IPFS Discourse topic
prerelease example
release example
[x] use Kubo vX.Y.Z(-RCN) is out! as the title
[x] use kubo and go-ipfs as topics
[x] repeat the title as a heading (##) in the description
[x] link to the GitHub Release, binaries on IPNS, docker pull command and release notes in the description
[x] pin the IPFS Discourse topic globally
you can make the topic a banner if there is no banner already
verify the IPFS Discourse topic was copied to:
[x] #ipfs-chatter in IPFS Discord
[x] #ipfs-chatter in FIL Slack
[x] #ipfs-chatter:ipfs.io in Matrix
[ ] Add the link to the IPFS Discourse topic to the GitHub Release description
example
[ ] create an issue comment mentioning early testers on the release issue
example
[ ] create an issue comment linking to the release on the release issue
example
[ ] ask the marketing team to tweet about the release in #shared-pl-marketing-requests in FIL Slack
example
[ ] post the link to the GitHub Release to Reddit
example

[ ] ~~Test the new version with ipfs-companion~~ (currently skipped)

using ./kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion or ...

[ ] run the e2e
use vX.Y.Z(-RCN) as the Kubo image version
[ ] wait for the e2e workflow run to finish

[ ]

Update Kubo in ipfs-desktop

using ./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-desktop or ...

[ ] check out ipfs/ipfs-desktop
[ ] run npm install
[ ] create a PR which updates package.json and package-lock.json
[ ] add @SgtPooki as reviewer

[ ]

Update Kubo docs

using ./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-docs or ...

[ ] run the update-on-new-ipfs-tag.yml workflow
[ ] merge the PR created by the update-on-new-ipfs-tag.yml workflow run

[ ]

Create a blog entry on blog.ipfs.tech

using ./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-blog --date YYYY-MM-DD or ...

[ ] create a PR which adds a release note for the new Kubo version
example
[ ] merge the PR
[ ] verify the blog entry was published

[ ]

Merge the release branch back into master, ignoring the changes to version.go (keep the -dev) version,

using ./kuboreleaser release --version vX.Y.Z(-rcN) merge-branch or ...

[ ] create a new branch merge-release-vX.Y.Z from release
[ ] create and merge a PR from merge-release-vX.Y.Z to master

[ ]

Prepare for the next release

using ./kuboreleaser release --version vX.Y.Z(-rcN) prepare-next or ...

[ ] Create the next changelog
[ ] Link to the new changelog in the CHANGELOG.md file
[ ] Create the next release issue

[ ]

Create a dependency update PR

[ ] check out ipfs/kubo
[ ] go over direct dependencies from go.mod in the root directory (NOTE: do not run go get -u as it will upgrade indirect dependencies which may cause problems)
[ ] run make mod_tidy
[ ] create a PR which updates go.mod and go.sum
[ ] add the PR to the next release milestone

[ ]

Close the release issue

lidel commented 23 hours ago

✅ Release Checklist (v0.31.0-rc2)

[x] Prepare the release branch and update version numbers accordingly
using ./kuboreleaser --skip-check-before release --version vX.Y.Z(-rcN) prepare-branch or ...
- [ ] create a new branch release-vX.Y.Z
- use master as base if Z == 0
- use release as base if Z > 0
- [ ] update the CurrentVersionNumber in version.go in the master branch to vX.Y+1.0-dev
- example
- [x] update the CurrentVersionNumber in version.go in the release-vX.Y branch to vX.Y.Z(-RCN)
- example
- [ ] create a draft PR from release-vX.Y to release
- example
- [ ] Cherry-pick commits from master to the release-vX.Y.Z using git cherry-pick -x <commit>
- [ ] Add full changelog and contributors to the changelog
- [ ] Replace the Changelog and Contributors sections of the changelog with the stdout of ./bin/mkreleaselog. Note that the command expects your $GOPATH/src/github.com/ipfs/kubo to include latest commits from release-vX.Y
  - do NOT copy the stderr
- [ ] verify all CI checks on the PR from release-vX.Y to release are passing
- [ ] Merge the PR from release-vX.Y to release using the Create a merge commit
- do NOT use Squash and merge nor Rebase and merge because we need to be able to sign the merge commit
- do NOT delete the release-vX.Y branch

[x] Create the release tag

using ./kuboreleaser release --version vX.Y.Z(-rcN) tag or ...

This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
[x] ⚠️ tag the HEAD commit using git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'
[ ] ⚠️ tag the HEAD commit of the release branch using git tag -s vX.Y.Z -m 'Release X.Y.Z'
[ ] ⚠️ verify the tag is signed and tied to the correct commit using git show vX.Y.Z(-RCN)
[x] ⚠️ push the tag to GitHub using git push origin vX.Y.Z(-RCN)
do NOT use git push --tags because it pushes all your local tags

[ ] Verify ipfs/distributions's .tool-versions's golang entry is set to the latest go release on the major go branch Kubo is being tested on (see go-version:).

[ ] Publish to Dockerhub, NPM, and dist.ipfs.tech and GitHub using ./kuboreleaser --skip-check-before --skip-run release --version vX.Y.Z(-rcN) publish-to-all or follow each step below:

[x] Publish the release to DockerHub
using ./kuboreleaser --skip-check-before --skip-run release --version vX.Y.Z(-rcN) publish-to-dockerhub or ...
[ ] Wait for Publish docker image workflow run initiated by the tag push to finish
[ ] verify the image is available on Docker Hub
[x] Publish the release to dist.ipfs.tech
using ./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-distributions or ...
[ ] check out ipfs/distributions
[ ] run ./dist.sh add-version kubo vX.Y.Z(-RCN) to add the new version to the versions file
- usage
[ ] create and merge the PR which updates dists/kubo/versions and dists/go-ipfs/versions ( and dists/kubo/current_version and dists/go-ipfs/current_version)
- example
[ ] wait for the CI workflow run initiated by the merge to master to finish
[ ] verify the release is available on dist.ipfs.tech
[x] Publish the release to NPM
using ./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-npm (⚠️ you might need to run the command a couple of times because GHA might not be able to see the new distribution straight away due to caching) or ...
[ ] run the Release to npm workflow
[ ] check Release to npm workflow run logs to verify it discovered the new release
[ ] verify the release is available on NPM
[x] Publish the release to GitHub
using ./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-github or ...
[ ] create a new release on GitHub
- RC example
- FINAL example
- [ ] use the vX.Y.Z(-RCN) tag
- [ ] link to the release issue
- [ ] link to the changelog in the description
- [ ] check the This is a pre-release checkbox
- [ ] copy the changelog (without the header) in the description
- [ ] do NOT check the This is a pre-release checkbox
[ ] run the sync-release-assets workflow
[ ] wait for the sync-release-assets workflow run to finish
[ ] verify the release assets are present in the GitHub release

[ ] Update Kubo staging environment, see the Running Kubo tests on staging for details.

[ ] Test last release against the current RC
[ ] Test last release against the current one