coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 10:27:46 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
ceed43ea0e
kubo/docs/RELEASE_ISSUE_TEMPLATE.md
omahs 698166bf2a
docs: fix typos
2023-03-06 09:42:54 -05:00

19 KiB
Raw Blame History

Release Issue Template. If doing a patch release, see here

Items to do upon creating the release issue

  • Fill in the Meta section
  • Assign the issue to the release owner and reviewer.
  • Name the issue "Release vX.Y.Z"
  • Set the proper values for X.Y.Z
  • Pin the issue

Meta

  • Release owner: @who
  • 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 for more info.

Kubo X.Y.Z Release

We're happy to announce Kubo X.Y.Z!

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). Ideally, 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 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 and create banners. @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/vX.Y.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.
      • PR link:
    • Ensure the new changelog is linked in the CHANGELOG.md file.
    • 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
    • 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 targeting 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-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
      • 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).
        • 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).
      • 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 off a run manually)
    • Cut a pre-release on GitHub (instructions, example)
      • Use vX.Y.Z-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 vX.Y.Z-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.
      • If there is no more important banner currently set on Discourse (e.g. IPFS Camp announcement), make the topic into a banner.
      • 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 investigating 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 communication 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 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 polluted 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-vX.Y.Z branch to GitHub (git push origin release-vX.Y.Z)
      • Mark the PR created from release-vX.Y.Z as ready for review.
        • Ensure the PR is targeting 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-vX.Y.Z 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 vX.Y.Z (git tag -s vX.Y.Z -m 'Release X.Y.Z')
        • Run git show vX.Y.Z to ensure the tag is correct.
        • ⚠️ Push the vX.Y.Z tag to GitHub (git push origin vX.Y.Z; 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-vX.Y.Z) from master.
        • Run ./dist.sh add-version kubo vX.Y.Z to add the new version to the versions file (instructions).
        • Push the kubo-release-vX.Y.Z 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 off a run manually)
    • Cut the release on GitHub (instructions, example)
      • Use vX.Y.Z as the tag.
      • 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.
    • 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. (example)
        • Use Kubo vX.Y.Z 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.
      • If there is no more important banner currently set on Discourse (e.g. IPFS Camp announcement), make the topic into a banner.
      • 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.17.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
    • Share the link to the GitHub release
      • 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: