docs: init release issue template improvement process v0.16.0 #9283
Conversation
galargh
force-pushed
the
docs-release-0.16.0
branch
from
369806d
to
5d2f337
Compare
|
@galargh : I haven't looked at this PR yet. One quick observation on the release notes is that:
|
I haven't had time yet to include the notes from the final release in this PR. I wanted to do it today but now it looks like it's getting pushed to tomorrow. I'll be marking this PR as ready for review once that's done. |
| ## Release improvements for next time | ||
|
|
||
| < Add any release improvements that were observed this cycle here so they can get incorporated into future releases. > | ||
|
|
There was a problem hiding this comment.
We're capturing these in a release retro doc and the release issue template update PR (like this one) instead, right?
| ## 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. > | ||
|
|
There was a problem hiding this comment.
I'm not sure what these are supposed to be and I couldn't find this section filled out in the past releases.
docs/RELEASE_ISSUE_TEMPLATE.md
Outdated
| ### Changelog | ||
|
|
||
| < changelog generated by bin/mkreleaselog > (add it to a separated comment if it is too big) | ||
|
|
||
| ### ❤️ Contributors | ||
|
|
||
| < list generated by bin/mkreleaselog > |
There was a problem hiding this comment.
I propose to comment with a link to the final release on the release issue instead. The final release will already have this information.
@BigLep Unfortunately, GitHub uses differend md rendering in https://github.com/ipfs/kubo/releases/tag/v0.16.0 and in https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.16.md. The former doesn't support links and it seems to be handling line breaks differently. I'll see if this was already raised somewhere and if not I'll do it myself. |
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
This PR captures improvements to the release issue template based on 0.16.0 release.
The instructions were followed during the 0.16.0 release and will be tested again during the 0.17.0 release.
The end goal is to introduce some kind of a workflow automation to the release process. This is only step 1 - making the release checklist more complete.