Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.17 #9319

Closed
BigLep opened this issue Sep 30, 2022 · 17 comments
Closed

Release 0.17 #9319

BigLep opened this issue Sep 30, 2022 · 17 comments
Assignees

Comments

@BigLep
Copy link
Contributor

BigLep commented Sep 30, 2022

Meta

See the Kubo release process for more info.

Initial planning

Themes

  1. (@guseggert) Filecoin/IPFS interop
  2. Prepare for IPFS Camp
    • Talks
    • General Lisbon support
  3. (All) 6-month Roadmapping
  4. (@ajnavarro) Protect Kubo nodes by default with the go-libp2p resource manager: Improve resource manager UX #9001
  5. (@Jorropo) Address DAG handling issues
  6. (@Jorropo) UnixFS spec
  7. (@hacdias) Gateway:
  8. 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

<List of items with PRs and/or Issues to be considered for this release>

Required

Nice to have

🔦 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
  • 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:
      • 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
    • 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:

@BigLep
Copy link
Contributor Author

BigLep commented Nov 7, 2022

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

  1. 0.16.0 is crashing: connmgr: concurrent map iteration and map write #9374
  2. Daemon ignores filters and trigger NetScan abuse #8585

@p-shahi
Copy link

p-shahi commented Nov 8, 2022

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
Copy link
Member

ajnavarro commented Nov 8, 2022

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

@BigLep
Copy link
Contributor Author

BigLep commented Nov 8, 2022

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

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

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

  1. 0.16.0 is crashing: connmgr: concurrent map iteration and map write #9374
  2. Daemon ignores filters and trigger NetScan abuse #8585

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

@galargh
Copy link
Contributor

galargh commented Nov 10, 2022

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

@BigLep BigLep moved this from 🥞 Todo to 🏃‍♀️ In Progress in IPFS Shipyard Team Nov 10, 2022
@BigLep
Copy link
Contributor Author

BigLep commented Nov 10, 2022

2022-11-10 conversation:

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

@galargh
Copy link
Contributor

galargh commented Nov 10, 2022

Early testers ping for RC1 testing 😄.

You're getting this message because you're listed here. Please update this list if you no longer want to be included.

@galargh galargh moved this from 🤔 Triage to ✍️ In Progress in InterPlanetary Developer Experience Nov 14, 2022
@BigLep
Copy link
Contributor Author

BigLep commented Nov 14, 2022

@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
Copy link
Contributor Author

BigLep commented Nov 15, 2022

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

  1. fix: Stop RM errors when using acceleratedDHT #9407
  2. refactor(config): remove Swarm.ConnMgr defaults #8913
  3. fix: update go-unixfs to v0.4.1 #9402

We need to update the changelog with:

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
Copy link
Member

lidel commented Nov 15, 2022

@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
Copy link
Contributor

galargh commented Nov 16, 2022

@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
Copy link
Contributor Author

BigLep commented Nov 16, 2022

@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
Copy link
Contributor

galargh commented Nov 16, 2022

Early testers ping for RC2 testing 😄.

You're getting this message because you're listed here. Please update this list if you no longer want to be included.

@galargh
Copy link
Contributor

galargh commented Nov 17, 2022

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
Copy link
Contributor

galargh commented Nov 17, 2022

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

@galargh
Copy link
Contributor

galargh commented Nov 22, 2022

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

This was referenced Nov 23, 2022
@galargh
Copy link
Contributor

galargh commented Nov 25, 2022

Next release -> #9417

@galargh galargh closed this as completed Dec 2, 2022
Repository owner moved this from 🏃‍♀️ In Progress to 🎉 Done in IPFS Shipyard Team Dec 2, 2022
Repository owner moved this from ✍️ In Progress to 🥳 Done in InterPlanetary Developer Experience Dec 2, 2022
@galargh galargh unpinned this issue Dec 5, 2022
@galargh galargh mentioned this issue Dec 5, 2022
@galargh galargh mentioned this issue Feb 6, 2023
@galargh galargh mentioned this issue Apr 6, 2023
@hacdias hacdias mentioned this issue Jun 13, 2023
@Jorropo Jorropo mentioned this issue Jul 27, 2023
@Jorropo Jorropo mentioned this issue Aug 7, 2023
96 tasks
@Jorropo Jorropo mentioned this issue Sep 25, 2023
14 tasks
@hacdias hacdias mentioned this issue Nov 1, 2023
11 tasks
@hacdias hacdias mentioned this issue Dec 6, 2023
9 tasks
@hacdias hacdias mentioned this issue Jan 11, 2024
3 tasks
@hacdias hacdias mentioned this issue Feb 20, 2024
8 tasks
@hacdias hacdias mentioned this issue Apr 9, 2024
11 tasks
@hacdias hacdias mentioned this issue May 27, 2024
9 tasks
@lidel lidel mentioned this issue Aug 21, 2024
32 tasks
@gammazero gammazero mentioned this issue Oct 3, 2024
34 tasks
@lidel lidel mentioned this issue Oct 30, 2024
28 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

No branches or pull requests

5 participants