Release 0.17 #9319

BigLep · 2022-09-30T14:21:11Z

Initial planning

Themes

(@guseggert) Filecoin/IPFS interop
- Reframe in production: [Tracking issue] http delegated routing used in production #9150
- Reframe GET dag-cbor support
- Any necessary Bitswap fixes/improvements
Prepare for IPFS Camp
- Talks
  - (@lidel) Example application based on dag-cbor b-tree
  - (@lidel) Specs
  - (@Jorropo) Data transfer / faster download
  - (@Jorropo) UnixFS
- General Lisbon support
(All) 6-month Roadmapping
(@ajnavarro) Protect Kubo nodes by default with the go-libp2p resource manager: Improve resource manager UX #9001
(@Jorropo) Address DAG handling issues
(@Jorropo) UnixFS spec
(@hacdias) Gateway:
- Brave fix around DNSLinks on localhost: Gateway: add UseInlinedDNSLink flag to config #9243
- dag-json / dag-cbor responses: feat(gateway): JSON and CBOR response formats (IPIP-328) #9335
- TAR responses: feat(gateway): TAR response format #9029
Cleanup the Kubo RPC story: [Tracking Issue] Cleanup Kubo RPC Client Story #9142

Kubo 0.17.0 Release

We're happy to announce Kubo 0.17.0!

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 security fix policy for details.

🗺 What's left for release

Required

feat: Improve ResourceManager UX #9338

Nice to have

chore: Update go-libp2p to v0.23.4 #9387

🔦 Highlights

< top highlights for this release notes. For ANY version (final or RCs) >

✅ Release Checklist

Checklist:

Stage 0 - Prerequisites
- Open an issue against bifrost-infra ahead of the release (example).
  - 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
- 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-v0.17.0 branch, open a draft PR and keep updating docs/RELEASE_ISSUE_TEMPLATE.md on that branch as you go.
- Ensure you have a GPG key generated and added to your GitHub account. This will enable you to created signed tags.
- Ensure you have admin access to IPFS Discourse. Admin access is required to globally pin posts. @2color might be able to assist you.
- Access to #bifrost channel in FIL Slack might come in handy. Ask the release reviewer to invite you over.
- Access to #shared-pl-marketing-requests channel in FIL Slack will be required to request social shares. Ask the release reviewer to invite you over.
- After the release is deployed to our internal infrastructure, you're going to need read access to 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).
- You're also going to need NPM installed on your system. See here for instructions.
- Prepare changelog proposal in docs/changelogs/v0.17.md.
  - 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.
- Install ZSH (instructions). 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.
- Ensure that README.md is up to date.
Stage 1 - Initial Preparations
- Upgrade to the latest patch release of Go that CircleCI has published (currently used version: 1.19.1)
  - See the list here: https://hub.docker.com/r/cimg/go/tags
  - ipfs/distributions: bump this version
  - ipfs/kubo: example PR
  - ipfs/ipfs-docs: example PR
- Fork a new branch (release-v0.17.0) from master.
- Bump the version in version.go in the master branch to v0.18.0-dev via a PR (example).
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.go in the release-v0.17.0 branch to v0.17.0-rcN.
- If applicable, add new commits to the release-v0.17.0 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-v0.17.0) and when everything is settled push to release-v0.17.0
- Push the release-v0.17.0 branch to GitHub (git push origin release-v0.17.0) and create a draft PR targetting release branch if it doesn't exist yet (example).
- 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-v0.17.0 commit with v0.17.0-rcN (git tag -s v0.17.0-rcN -m 'Pre-release 0.17.0-rcn')
  - Run git show v0.17.0 to ensure the tag is correct.
  - ⚠️ Push the v0.17.0 tag to GitHub (git push origin v0.17.0; 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
  - Clone the ipfs/distributions repo locally.
  - Create a new branch (kubo-release-v0.17.0-rcn) from master.
  - Run ./dist.sh add-version kubo v0.17.0-rcN to add the new version to the versions file (instructions).
    - dist.sh will print WARNING: not marking pre-release kubo v0.17.0-rc1n as the current version..
  - Push the kubo-release-v0.17.0-rcn branch to GitHub and create a PR from that branch (example).
  - Ask for a review from the release reviewer.
  - Enable auto-merge for the PR.
    - PR build will build the artifacts and generate a diff in around 30 minutes
    - PR will be merged automatically once the diff is approved
    - 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 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 (instructions, example)
  - Use v0.17.0-rcN as the tag.
  - Link to the release issue in the description.
  - Link to the relevant changelog in the description.
  - Check This is a pre-release.
- Synchronize release artifacts by running sync-release-assets workflow.
- Announce the RC
  - Create a new post on IPFS Discourse. (example)
    - Use Kubo v0.17.0-rcn Release Candidate is out! as the title.
    - Use kubo and go-ipfs as topics.
    - Repeat the title as a heading (##) in the description.
    - Link to the GitHub Release, binaries on IPNS, docker pull command and release notes in the description.
  - Pin the topic globally so that it stays at the top of the category.
  - Check if Discourse post was automatically copied to:
    - IPFS Discord #ipfs-chatter
    - FIL Slack #ipfs-chatter
    - Matrix https://matrix.to/#/#ipfs-chatter:ipfs.io
  - Mention early testers in the comment under the release issue (example).
Stage 3 - Internal Testing
- Infrastructure Testing.
  - Update the issue against bifrost-infra (example).
    - Mention @protocol/bifrost-team in the issue to let them know the release is ready
    - [Optional] Reply under a message about the issue in the #bifrost channel on FIL Slack once the RC is out. Send the message to the channel.
  - Check metrics every day.
    - Compare the metrics trends week over week.
    - If there is an unexpected variation in the trend, message the #bifrost channel on FIL Slack and ask for help investigation the cause.
- IPFS Application Testing.
  - IPFS Desktop
    - Upgrade to the RC in ipfs-desktop
    - Run npm install to update package-lock.json.
    - Push to a branch (example)
    - Open a draft PR to track through the final release (example)
    - Ensure CI tests pass
  - IPFS Companion
    - Start kubo daemon of the version to release.
    - Start a fresh chromium or chrome instance using chromium --user-data-dir=$(mktemp -d) (macos /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --user-data-dir=$(mktemp -d))
    - Start a fresh firefox instance using firefox --profile $(mktemp -d) (macos /Applications/Firefox.app/Contents/MacOS/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.
Stage 5 - Release - ONLY FOR FINAL RELEASE
- Prepare the release branch.
  - Bump the version in version.go in the release-v0.17.0 branch to v0.17.0.
  - Update the docs/changelogs/v0.17.md 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.
    - Paste the output into the ### Changelog section of the changelog file inside the <details><summary></summary></details> block.
    - Commit the changelog changes.
  - Push the release-v0.17.0 branch to GitHub (git push origin release-v0.17.0)
  - Mark the PR created from release-v0.17.0 as ready for review.
    - Ensure the PR is targetting release branch.
    - Ensure that CI is green.
    - Have release reviewer review the PR.
  - Merge the PR into release branch 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-v0.17.0 branch.
  - Checkout the release branch locally.
    - Remember to pull the latest changes.
  - Create a signed tag for the release.
    - 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 commit with v0.17.0 (git tag -s v0.17.0 -m 'Release 0.17.0')
    - Run git show v0.17.0 to ensure the tag is correct.
    - ⚠️ Push the v0.17.0 tag to GitHub (git push origin v0.17.0; DO NOT USE git push --tags because it pushes all your local tags).
- Publish the release.
  - Wait for Publish docker image workflow run initiated by the tag push to finish.
  - Add artifacts to https://dist.ipfs.tech by making a PR against ipfs/distributions
    - Clone the ipfs/distributions repo locally.
    - Create a new branch (kubo-release-v0.17.0) from master.
    - Run ./dist.sh add-version kubo v0.17.0 to add the new version to the versions file (instructions).
    - Push the kubo-release-v0.17.0 branch to GitHub and create a PR from that branch (example).
    - Ask for a review from the release reviewer.
    - Enable auto-merge for the PR.
      - PR build will build the artifacts and generate a diff in around 30 minutes
      - PR will be merged automatically once the diff is approved
      - 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 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 (instructions, example)
  - Use v0.17.0 as the tag.
  - Link to the release issue in the description.
  - Copy the relevant changelog into the release description.
    - Keep the release notes as trim as possible (e.g. remove top headers where possible, example)
- Synchronize release artifacts by running sync-release-assets workflow.
- Announce the release
  - Add a link to the release to this release issue as a comment.
  - Create a new post on IPFS Discourse. (example)
    - Use Kubo v0.17.0 Release is out! as the title.
    - Use kubo and go-ipfs as topics.
    - Repeat the title as a heading (##) in the description.
    - Link to the GitHub Release, binaries on IPNS, docker pull command and release notes in the description.
  - Pin the topic globally so that it stays at the top of the category.
  - Check if Discourse post was automatically copied to:
    - 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.15.0)
- Update the draft PR created for interop to use the new release and mark it as ready for review.
- Update the draft PR created for 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)
- Get the blog post created and shared
  - Submit a request for blog post creation using the form.
    - Notify marketing in #shared-pl-marketing-requests about the blog entry request (since the form tends to go to spam; example).
  - The post is live on https://blog.ipfs.io
  - Share the blog post
    - Twitter (request in Filecoin Slack channel #shared-pl-marketing-requests; example)
    - Reddit
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.
- Close this release issue.

How to contribute?

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
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!

The text was updated successfully, but these errors were encountered:

BigLep · 2022-11-07T13:54:25Z

@galargh : can you please followup with the team to see if either of these need to be addressed before we start the release:

p-shahi · 2022-11-08T03:11:47Z

0.16.0 is crashing

Started a discussion in the linked libp2p issue. Please let us know if you need a fix in 0.17.0

A separate question: will Kubo update to https://github.com/libp2p/go-libp2p/releases/tag/v0.23.3 to resolve libp2p/go-libp2p-relay-daemon#18 (comment)?

ajnavarro · 2022-11-08T11:04:19Z

@p-shahi Update to v0.23.3 here #9387

BigLep · 2022-11-08T18:24:00Z

2022-11-08 maintainer: conversation on what's needed before RC:

@guseggert Updates config.md and release notes around Reframe in light of whatever gets decided for Reframe/HTTP Delegated routing in IPIP-337: Delegated Content Routing HTTP API specs#337
go-libp2p update: chore: Update go-libp2p to v0.23.4 #9387 (@guseggert to review)

These are nice to haves that we'd like to see land in time:

@lidel New WebUI release with updated GeoIP DB and WebTransport fix
@ajnavarro Resource Manager on by default:

Items that will get fixed in the RC phase or in a followup release:

The plan regardless is still to do an RC on 2022-11-10.

galargh · 2022-11-10T14:49:06Z

2022-11-10: Investigating 2 issues that are currently halting the release:

webui tests failing for chore: bump go version to 1.19.3 #9392 (edit: postponed)
collab cluster being unreachable during builds of chore: bump go version to 1.19.3 distributions#773 (edit: bifrost team is looking into it)

BigLep · 2022-11-10T15:56:32Z

2022-11-10 conversation:

We'll put the go upgrade on the shelf
Goal is to get through Stage 2 today (if collab cluster is operational again)
@guseggert will get in resource manager notes into https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.17.md

galargh · 2022-11-10T22:56:18Z

BigLep · 2022-11-14T15:40:52Z

@lidel @galargh : I think we should put a proactive message in #ipfs-operators about this RC given the criticality of resource manager being enabled by default and that being important for their node safety. I'm happy to sync up offline regarding messaging.

BigLep · 2022-11-15T17:43:23Z

2022-11-15 conversation:
We're going to make to a new RC that will include:

We need to update the changelog with:

@ajnavarro resource manager defaults and commands: Doc improvements and changelog for resource manager #9413
@lidel connection manager cleanup (refactor(config): remove Swarm.ConnMgr defaults #8913)
@lidel new go-libp2p with bug fixes including web sockets behind reverse proxy (docs: document /wss fix in 0.17 (go-libp2p 0.23.3) #9409)
- let's have @TheDiscordian test this when he is back (he is OoO atm)

Seperately we'll look at Bifrost resource manager default setting: https://github.com/protocol/bifrost-infra/blob/master/ansible/inventories/bifrost/group_vars/gateway_ipfs_bank1.yml

lidel · 2022-11-15T21:05:03Z

@galargh FYSA I've reviewed/merged/cherry-picked remaining things, should be ready for RC2
(see the tail of the release-v0.17.0 changes in your PR #9395).

(missing changelog entries can be updated later, it does not block RC2 imo)

galargh · 2022-11-16T08:45:06Z

@galargh FYSA I've reviewed/merged/cherry-picked remaining things, should be ready for RC2 (see the tail of the release-v0.17.0 changes in your PR #9395).

(missing changelog entries can be updated later, it does not block RC2 imo)

Thank you! I'll be starting the process for RC2 release shortly.

BigLep · 2022-11-16T09:24:34Z

@galargh : There are various doc updates (including changelog in #9413 ). I guess since these are doc based, they don't have to make it in the RC.

When Bifrost attempts to deploy this RC-2 out, I believe we should have them try simplified configuration per https://github.com/protocol/bifrost-infra/issues/1815#issuecomment-1316651157 so that we're actually getting vetting of the default configuration.

galargh · 2022-11-16T14:44:56Z

galargh · 2022-11-17T14:31:12Z

Given we released the RC2 yesterday and are still in the process of rolling it out to internal infrastructure, we're most likely going to postpone the final release until next week. To be confirmed later today.

galargh · 2022-11-17T19:24:08Z

Moving the final release to ~~2022-11-21~~ 2022-11-22.

galargh · 2022-11-22T16:21:06Z

The final release is here! https://github.com/ipfs/kubo/releases/tag/v0.17.0

Part of ipfs/kubo#9319 https://github.com/ipfs/kubo/releases/tag/v0.17.0

galargh · 2022-11-25T16:43:52Z

Next release -> #9417

BigLep pinned this issue Sep 30, 2022

BigLep assigned galargh Oct 4, 2022

galargh mentioned this issue Oct 18, 2022

chore: create v0.17.md changelog #9353

Merged

p-shahi mentioned this issue Nov 8, 2022

connmgr: Concurrent Map Misuse libp2p/go-libp2p#1847

Closed

lidel mentioned this issue Nov 8, 2022

feat: update to ipfs-geoip v9 ipfs/ipfs-webui#2061

Merged

lidel mentioned this issue Nov 9, 2022

feat: ipfs-webui 2.20.0 #9390

Merged

BigLep mentioned this issue Nov 10, 2022

docs: release process updates from v0.17.0 #9391

Merged

lidel mentioned this issue Nov 15, 2022

docs: document /wss fix in 0.17 (go-libp2p 0.23.3) #9409

Merged

lidel mentioned this issue Nov 15, 2022

0.16.0 is crashing: connmgr: concurrent map iteration and map write #9374

Closed

3 tasks

galargh mentioned this issue Nov 22, 2022

release v0.17.0 #9395

Merged

This was referenced Nov 22, 2022

feat: kubo v0.17.0 ipfs/interop#539

Merged

feat: kubo v0.17.0 ipfs/ipfs-desktop#2338

Merged

lidel pushed a commit to ipfs/interop that referenced this issue Nov 22, 2022

feat: kubo v0.17.0 (#539)

b465053

Part of ipfs/kubo#9319 https://github.com/ipfs/kubo/releases/tag/v0.17.0

galargh mentioned this issue Nov 23, 2022

Release v0.17.0 #9430

Closed

galargh mentioned this issue Nov 23, 2022

Merge release v0.17.0 #9431

Merged

galargh closed this as completed Dec 2, 2022

galargh unpinned this issue Dec 5, 2022

galargh mentioned this issue Dec 5, 2022

Release 0.18 #9417

Closed

galargh mentioned this issue Jan 30, 2023

Release 0.18.1 #9579

Closed

galargh mentioned this issue Feb 6, 2023

Release 0.19 #9502

Closed

galargh mentioned this issue Mar 27, 2023

Release 0.19.1 #9754

Closed

galargh mentioned this issue Apr 6, 2023

Release 0.20 #9694

Closed

hacdias mentioned this issue Jun 13, 2023

Release 0.21 #9814

Closed

Jorropo mentioned this issue Jul 27, 2023

Release 0.22 #9911

Closed

Jorropo mentioned this issue Aug 7, 2023

Release 0.21.1 #10048

Closed

96 tasks

Jorropo mentioned this issue Sep 25, 2023

Release 0.23 #10014

Closed

14 tasks

hacdias mentioned this issue Nov 1, 2023

Release 0.24 #10043

Closed

11 tasks

hacdias mentioned this issue Dec 6, 2023

Release 0.25 #10045

Closed

9 tasks

hacdias mentioned this issue Jan 11, 2024

Release 0.26 #10259

Closed

3 tasks

hacdias mentioned this issue Feb 20, 2024

Release 0.27 #10306

Closed

8 tasks

hacdias mentioned this issue Apr 9, 2024

Release 0.28 #10353

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release 0.17 #9319

Release 0.17 #9319

BigLep commented Sep 30, 2022 •

edited by galargh

BigLep commented Nov 7, 2022

p-shahi commented Nov 8, 2022

ajnavarro commented Nov 8, 2022 •

edited

BigLep commented Nov 8, 2022 •

edited by galargh

galargh commented Nov 10, 2022 •

edited

BigLep commented Nov 10, 2022

galargh commented Nov 10, 2022 •

edited by BigLep

BigLep commented Nov 14, 2022

BigLep commented Nov 15, 2022 •

edited by galargh

lidel commented Nov 15, 2022

galargh commented Nov 16, 2022

BigLep commented Nov 16, 2022

galargh commented Nov 16, 2022

galargh commented Nov 17, 2022

galargh commented Nov 17, 2022 •

edited

galargh commented Nov 22, 2022

galargh commented Nov 25, 2022

Release 0.17 #9319

Release 0.17 #9319

Comments

BigLep commented Sep 30, 2022 • edited by galargh

Meta

Initial planning

Themes

Kubo 0.17.0 Release

🗺 What's left for release

Required

Nice to have

🔦 Highlights

✅ Release Checklist

How to contribute?

BigLep commented Nov 7, 2022

p-shahi commented Nov 8, 2022

ajnavarro commented Nov 8, 2022 • edited

BigLep commented Nov 8, 2022 • edited by galargh

galargh commented Nov 10, 2022 • edited

BigLep commented Nov 10, 2022

galargh commented Nov 10, 2022 • edited by BigLep

BigLep commented Nov 14, 2022

BigLep commented Nov 15, 2022 • edited by galargh

lidel commented Nov 15, 2022

galargh commented Nov 16, 2022

BigLep commented Nov 16, 2022

galargh commented Nov 16, 2022

galargh commented Nov 17, 2022

galargh commented Nov 17, 2022 • edited

galargh commented Nov 22, 2022

galargh commented Nov 25, 2022

BigLep commented Sep 30, 2022 •

edited by galargh

ajnavarro commented Nov 8, 2022 •

edited

BigLep commented Nov 8, 2022 •

edited by galargh

galargh commented Nov 10, 2022 •

edited

galargh commented Nov 10, 2022 •

edited by BigLep

BigLep commented Nov 15, 2022 •

edited by galargh

galargh commented Nov 17, 2022 •

edited