Release 0.16
Meta
- Release owner: @galargh
- Release reviewer: @ajnavarro
- Expected RC date: ~2022-09-22~ 2022-09-26
- Expected final release date: ~2022-09-29~ 2022-10-03
- Accompanying PR for improving the release process: https://github.com/ipfs/kubo/pull/9283
See the Kubo release process for more info.
Initial planning
Themes
- Clean up cruft
- Reframe / Gateway/indexer integration
- https://github.com/ipfs/kubo/issues/9150
- IPNS specs/degredation
- Kubo RPC libraries ? TBD
- Bitswap items TBD?
Items we're explicitly not doing
Items to document for users
-
_redirects: wip in https://github.com/ipfs/ipfs-docs/pull/1275
Kubo 0.16.0 Release
We're happy to announce Kubo 0.16.0, bla bla...
As usual, this release includes important fixes, some of which may be critical for security. Unless the fix addresses a bug being exploited in the wild, the fix will not be called out in the release notes. Please make sure to update ASAP. See our release process for details.
🗺 What's left for release
- [x] https://github.com/ipfs/kubo/pull/9265/
- [x] https://github.com/ipfs/kubo/pull/8927
- [x] https://github.com/ipfs/kubo/pull/9285
- [x] https://github.com/ipfs/kubo/pull/9274
- [ ] https://github.com/ipfs/kubo/pull/8890
- [ ] https://github.com/ipfs/kubo/pull/9293
Ideal, but not blocking:
- [ ] https://github.com/ipfs/kubo/issues/9297
- [ ] https://github.com/ipfs/kubo/pull/9053
🔦 Highlights
< top highlights for this release notes. For ANY version (final or RCs) >
✅ Release Checklist
- [ ] Stage 0 - Prerequisites
- [ ] Ensure that the
What's left for releasesection has all the checkboxes checked. If that's not the case, discuss the open items with Kubo maintainers and update the release schedule accordingly. - [x] Create
docs-release-vX.Y.Zbranch, open a draft PR and keep updatingdocs/RELEASE_ISSUE_TEMPLATE.mdon that branch as you go.
- [ ] Ensure that the
- [ ] Stage 1 - Initial Preparations
- [x] Upgrade to the latest patch release of Go that CircleCI has published
- [x] See the list here: https://hub.docker.com/r/cimg/go/tags
- [x] ipfs/distributions: bump this version
- [x] ipfs/kubo: example PR
- [ ] Fork a new branch (
release-vX.Y.Z) frommaster. - [ ] Bump the version in
version.goin themasterbranch tovX.(Y+1).0-dev.
- [x] Upgrade to the latest patch release of Go that CircleCI has published
- [ ] Stage 2 - Release Candidate - if any non-trivial changes need to be included in the release, return to this stage
- [ ] Bump the version in
version.goin therelease-vX.Y.Zbranch tovX.Y.Z-rcN. - [ ] If applicable, add new commits to the
release-vX.Y.Zbranch frommasterusinggit 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 torelease-vX.Y.Z
- Note:
- [ ] Tag HEAD
release-vX.Y.Zcommit withvX.Y.Z-rcN(git tag -s vX.Y.Z-rcN") - [ ] Push the
release-vX.Y.Zbranch to GitHub (git push origin release-vX.Y.Z). - [ ] Push the
vX.Y.Z-rcNtag to GitHub (git push origin vX.Y.Z-rcN; DO NOT USEgit push --tagsbecause it pushes all your local tags). - [ ] Add artifacts to https://dist.ipfs.tech by making a PR against ipfs/distributions with local changes produced by
add-version(see usage)- [ ] Wait for PR to build artifacts and generate diff (~30min)
- [ ] Inspect results, merge if CI is green and the diff looks ok
- [ ] Wait for
masterbranch to build and update DNSLink at https://dist.ipfs.tech (~30min)
- [ ] Cut a pre-release on GitHub and reuse signed artifacts from https://dist.ipfs.tech/kubo (upload the result of the
ipfs/distributionsbuild from the previous step). - [ ] Announce the RC
- [ ] Create a new post on IPFS Discourse. This will automatically post to IPFS Discord #ipfs-chatter. Examples from the past: 0.14.0
- [ ] Pin the topic. You need to be part of the admin group for that.
- [ ] To the early testers listed in docs/EARLY_TESTERS.md. Do this by copy/pasting their GitHub usernames and checkboxes as a comment to the release issue so they get a GitHub notification. (example)
- [ ] Bump the version in
- [ ] Stage 3 - Automated Testing
- [ ] 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) - [ ] interop
- [ ] go-ipfs-api
- [ ] go-ipfs-http-client
- [ ] WebUI
- [ ] unit, sharness, cross-build, etc (
- [ ] Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes:
- [ ] Stage 4 - Internal Testing
- [ ] CHANGELOG.md has been updated
- use
./bin/mkreleaselogto generate a nice starter list- you need to install
zsh.
- you need to install
- use
- [ ] Infrastructure Testing.
- [ ] Open an issue against https://github.com/protocol/bifrost-infra and spell out all that we want (e.g.,mgateways, bootstrapper, and cluster). example https://github.com/protocol/bifrost-infra/issues/2109
- [ ] Deploy new version to a subset of Bootstrappers
- [ ] Deploy new version to a subset of Gateways
- [ ] Deploy new version to a subset of Preload nodes
- [ ] Collect metrics every day. Work with the Infrastructure team to learn of any hiccup
- [ ] IPFS Application Testing - Run the tests of the following applications:
- [ ] IPFS Desktop
- [ ] Ensure the RC is published to the NPM package (happens automatically, just wait for CI)
- [ ] Upgrade to the RC in ipfs-desktop and push to a branch (example), and open a draft PR to track through the final release (example)
- [ ] Ensure CI tests pass, repeat for new RCs
- [ ] IPFS Companion
- Start kubo daemon of the version to release.
- Start a fresh chromium or chrome instance using
chromium --user-data-dir=$(mktemp -d) - Start a fresh firefox instance using
firefox --profile $(mktemp -d) - Install IPFS Companion from vendor-specific store.
- Check that the comunication between Kubo daemon and IPFS companion is working properly checking if the number of connected peers changes.
- [ ] IPFS Desktop
- [ ] CHANGELOG.md has been updated
- [ ] Stage 5 - Community Prod Testing
- [ ] Documentation
- [ ] Ensure that CHANGELOG.md is up to date
- [ ] Add a link from release notes to Discuss post (like we did here: https://github.com/ipfs/kubo/releases/tag/v0.15.0 )
- [ ] 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 )
- [ ] Ensure that README.md is up to date
- [ ] Update docs by merging the auto-created PR in https://github.com/ipfs/ipfs-docs/pulls (they are auto-created every 12 hours) (only for final releases, not RCs)
- [ ] Ensure that CHANGELOG.md is up to date
- [ ] Invite the wider community through (link to the release issue):
- [ ] discuss.ipfs.io
- [ ] Matrix
- [ ] Documentation
- [ ] Stage 6 - Release
- [ ] Final preparation
- [ ] Verify that version string in
version.gohas been updated. - [ ] Open a PR merging
release-vX.Y.Zinto thereleasebranch.- This should be reviewed by the person who most recently released a version of
go-ipfs. - Use a merge commit (no rebase, no squash)
- This should be reviewed by the person who most recently released a version of
- [ ] Prepare the command to use for tagging the merge commit (on the
releasebranch) withvX.Y.Z.- Use
git tag -sto ensure the tag is signed
- Use
- [ ] Have the tagging command reviewed by the person who most recently released a version of
go-ipfs- This is a dangerous operation, as it is difficult to reverse due to Go modules and automated Docker image publishing
- [ ] Push the tag
- Use
git push origin <tag> - DO NOT USE
git push --tags, as it will push ALL of your local tags - This should initiate a Docker build in GitHub Actions that publishes a
vX.Y.Ztagged Docker image to DockerHub
- Use
- [ ] Release published
- [ ] to dist.ipfs.tech
- [ ] to npm-go-ipfs (done by CI at ipfs/npm-go-ipfs, but ok to dispatch this job manually)
- [ ] to chocolatey (done by CI at ipfs/choco-go-ipfs, but ok to dispatch this job manually)
- [ ] Manually run the release workflow
- [ ] Wait for Chocolatey to approve the release (usually takes a few hours)
- [ ] to snap (done CI at snap/snapcraft.yaml)
- [ ] to github
- [ ] After publishing the GitHub release, run the workflow to attach the release assets: https://github.com/ipfs/go-ipfs/actions/workflows/sync-release-assets.yml
- [ ] to arch (flag it out of date)
- [ ] Cut a new ipfs-desktop release
- [ ] Verify that version string in
- [ ] Get a blog post created
- Submit a request using this form.
- Notify marketing in #shared-pl-marketing-requests about the blog entry request (since the form gets spam).
- Don't mark this as done until the blog entry is live.
- [ ] Broadcasting (link to blog post)
- [ ] Twitter (request in Filecoin Slack channel #shared-pl-marketing-requests)
- [ ] discuss.ipfs.io
- A bot auto-posts this to Discord and Matrix
- [ ] Final preparation
- [ ] Stage 7 - Post-Release
- [ ] Merge the
releasebranch back intomaster, ignoring the changes toversion.go(keep the-devversion 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.
- [ ] Mark PR draft created for IPFS Desktop as ready for review.
- [ ] Mark PR draft created from
docs-release-vX.Y.Zas ready for review.
- [ ] Merge the
⁉️ Do you have questions?
The best place to ask your questions about IPFS, how it works and what you can do with it is at discuss.ipfs.io. We are also available at the #ipfs channel on Freenode, which is also accessible through our Matrix bridge.
Release improvements for next time
< Add any release improvements that were observed this cycle here so they can get incorporated into future releases. >
Items for a separate comment
< Do these as a separate comment to avoid the main issue from getting too large and checkbox updates taking too long. >
Changelog
< changelog generated by bin/mkreleaselog > (add it to a separated comment if it is too big)
❤️ Contributors
< list generated by bin/mkreleaselog >
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 wantedlabel in the ipfs/kubo repo - Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt/#weekly-ipfs-all-hands
- Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built
- Join the discussion at discuss.ipfs.io and help users finding their answers.
- Join the 🚀 IPFS Core Implementations Weekly Sync 🛰 and be part of the action!
@ajnavarro @galargh : Slack thread on what's remaining before the release: https://filecoinproject.slack.com/archives/C03L0G3B4RX/p1663819594018819
We're moving the RC1 release to Monday (2022-09-26) to give enough headway for merging What's left for release. As of now, the rest of the schedule remains unchanged.
Thanks for updating the dates @galargh. To provide a bit more color, we aren't cutting the RC today because we just wrapped up the must-have work of https://github.com/ipfs/kubo/pull/9274 (and it's EOD Europoe time).
We don't do releases on Friday.
Pushing to Monday 2022-09-26 also gives us the ability to get two other items that were almost complete:
- [x] https://github.com/ipfs/kubo/pull/8890
- [x] https://github.com/ipfs/kubo/pull/9293
Early testers ping for RC1 testing 😄
- [ ] pacman.store (@RubenKelevra)
- [ ] Infura (@MichaelMure)
- [ ] Textile (@sanderpick)
- [ ] Pinata (@obo20)
- [ ] RTrade (@postables)
- [ ] QRI (@b5)
- [ ] Siderus (@koalalorenzo)
- [ ] Charity Engine (@rytiss, @tristanolive)
- [ ] Fission (@bmann)
- [ ] OrbitDB (@tabcat)
Something that needs to improved for next time in my opinion is working on the changelog before the RC. Right now someone doesn't see much on what has changes, what they should try, what they should look out for, etc.
Agreed, it would be beneficial to have it ready in time for the RC. BTW, here's a draft changelog that @ajnavarro prepared - https://github.com/ipfs/kubo/blob/v0.16.0-rc1/docs/changelogs/v0.16.md. It's also linked from the release. At the very least we should formalise how it gets created.
Remaining changelog items added in https://github.com/ipfs/kubo/pull/9315 (ready for review)
Here was the state of https://github.com/orgs/ipfs/projects/16/views/7?filterQuery=iteration%3A%22kubo+0.16%22 efore moving things to the next iteration/release. I attached as XLSX because copy/paste is causing column misalignment that I don't have time to figure out.
The AMD64 version appears to not be an AMD64 binary.
@benjistokman for which platform ? Macos, Linux, windows, ... ?
Linux
@benjistokman it's fine for me, can you show me which one is not amd64 ?
$ curl https://dist.ipfs.tech/kubo/v0.16.0/kubo_v0.16.0_linux-amd64.tar.gz | gzip -d | tar -xf -
$ cd kubo/
$ file ipfs
ipfs: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, BuildID[sha1]=202ba79f9e42d51a7d310edbd97e032d6e955f27, for GNU/Linux 3.2.0, with debug_info, not stripped
$ curl https://dist.ipfs.tech/go-ipfs/v0.16.0/go-ipfs_v0.16.0_linux-amd64.tar.gz | gzip -d | tar -xf -
$ cd go-ipfs/
$ file ipfs
ipfs: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, BuildID[sha1]=202ba79f9e42d51a7d310edbd97e032d6e955f27, for GNU/Linux 3.2.0, with debug_info, not stripped
Nevermind I was clicking on the Darwin one. I don't know why but the rest of the binaries didn't load. Sorry.
We have successfully release v0.16.0: https://github.com/ipfs/kubo/releases/tag/v0.16.0