-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
docs: release process updates from v0.17.0 #9391
Conversation
Making some changes that am seeing so far. Some of these changes are so I can leave PR comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for starting this.
A couple of things:
- The PR title of "docs: release v0.17.0" confused me a little. I didn't immediately map it to "release process updates from 0.17.0". I thought it might more generic a docs updates for 0.17 (not just about our release process). Maybe rename to "docs: release process updates from 0.17.0" for clarity?
- I think we need to tighten up steps around our changelog. I don't see anything that is making sure the changelog is filled in. For example, what we have right now doesn't hit on the highlights. I think ideally we should do this before the RC, or else it's really unclear for anyone why they should try out the RC.
@@ -14,7 +14,7 @@ | |||
* 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/9100) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am linking to this PR because we'll use it to set the right template in terms of PR title and description.
@@ -108,7 +111,7 @@ Checklist: | |||
- [ ] IPFS Discord #ipfs-chatter | |||
- [ ] FIL Slack #ipfs-chatter | |||
- [ ] Matrix https://matrix.to/#/#ipfs-chatter:ipfs.io | |||
- [ ] Mention [early testers](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md) in the comment under the release issue ([example](https://github.com/ipfs/kubo/issues/9237#issuecomment-1258072509)). | |||
- [ ] Mention [early testers](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md) in the comment under the release issue ([example](https://github.com/ipfs/kubo/issues/9319#issuecomment-1311002478)). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated the link because in the latest comment I added context for why folks were being pinged and how they get removed.
For example, while @b5 is still absolutely in the community, QRI is no-more and I don't think need to be pinged about Kubo releases.
b991450
to
5ff08e4
Compare
- [ ] **Stage 3 - Internal Testing** | ||
- [ ] Library Testing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We test these in Kubo CI.
- [ ] Update the draft PR created for [interop](https://github.com/ipfs/interop) to use the new release and mark it as ready for review. | ||
- [ ] Update the draft PR created for [IPFS Desktop](https://github.com/ipfs-shipyard/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](https://github.com/ipfs/ipfs-docs/pull/1263)) | ||
- [ ] Get the blog post created and shared | ||
- [ ] Get the blog post created |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no way to link to the blogpost as it's just a redirect to the GitHub release.
I removed my raw notes from the issue template - 4d1d0b7. I don't think we need them here in this form. I'm going to use them to create more user-friendly automation during 0.18. |
This is for capturing improvements to the release process as we go.
This accompanies #9319