Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

Latest commit

 

History

History
158 lines (131 loc) · 10.9 KB

RELEASE_ISSUE_TEMPLATE.md

File metadata and controls

158 lines (131 loc) · 10.9 KB
Raw

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 2022-MM-DD
  • 🚢 Expected final release date: 2022-MM-DD
  • Accompanying PR for improving the release process: (example: ipfs#9100)

See the Kubo release process for more info.

Kubo X.Y.Z Release

We're happy to announce Kubo X.Y.Z, 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

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

🔦 Highlights

< top highlights for this release notes >

✅ Release Checklist

For each RC published in each stage:

  • version string in version.go has been updated (in the release-vX.Y.Z branch).
  • new commits should be added to the release-vX.Y.Z branch from master using git cherry-pick -x ...
  • tag commit with vX.Y.Z-rcN
  • add artifacts to https://dist.ipfs.tech
    1. Make a PR against ipfs/distributions with local changes produced by add-version (see usage)
    2. Wait for PR to build artifacts and generate diff
    3. Inspect results, merge if CI is green and the diff looks ok
    4. Wait for master branch to build and update DNSLink at https://dist.ipfs.tech
  • cut a pre-release on github and reuse signed artifacts from https://dist.ipfs.tech/kubo (upload the result of the ipfs/distributions build in the previous step).
  • Announce the RC:
      • This will automatically post to IPFS Discord #ipfs-chatter
      • Examples from the past: 0.14.0
      • Pin the topic
    • To the early testers listed in docs/EARLY_TESTERS.md. Do this by copy/pasting their GitHub usernames and checkboxes as a comment so they get a GitHub notification. (example)

Checklist:

  • Stage 0 - Automated Testing
    • Upgrade to the latest patch release of Go that CircleCI has published
    • Fork a new branch (release-vX.Y.Z) from master and make any further release related changes to this branch. If any "non-trivial" changes (see the footnotes of docs/releases.md for a definition) get added to the release, uncheck all the checkboxes and return to this stage.
      • Follow the RC release process to cut the first RC.
      • Bump the version in version.go in the master branch to vX.(Y+1).0-dev.
    • Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes:
  • Stage 1 - Internal Testing
    • CHANGELOG.md has been updated
    • Infrastructure Testing:
      • 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:
  • Stage 2 - Community Prod Testing
  • Stage 3 - Release
    • Final preparation
      • Verify that version string in version.go has been updated.
      • Open a PR merging release-vX.Y.Z into the release branch.
        • This should be reviewed by the person who most recently released a version of go-ipfs.
        • Use a merge commit (no rebase, no squash)
      • Prepare the command to use for tagging the merge commit (on the release branch) with vX.Y.Z.
        • Use git tag -s to ensure the tag is signed
      • 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.Z tagged Docker image to DockerHub
      • Release published
      • Cut a new ipfs-desktop release
    • 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)
      • Reddit
      • discuss.ipfs.io
        • A bot auto-posts this to Discord and Matrix
  • 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.
    • 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.

⁉️ 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 >

❤️ 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: