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

docs: init release issue template improvement process v0.16.0 #9283

Merged
merged 16 commits into from
Oct 20, 2022

Conversation

galargh
Copy link
Contributor

@galargh galargh commented Sep 19, 2022

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.

@galargh galargh mentioned this pull request Sep 19, 2022
@BigLep
Copy link
Contributor

BigLep commented Oct 10, 2022

@galargh : I haven't looked at this PR yet. One quick observation on the release notes is that:

  1. Table of contents links don't work
  2. Sections like "Hardened IPNS record verification" seem to have odd line breaks.

@galargh
Copy link
Contributor Author

galargh commented Oct 10, 2022

@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.

Comment on lines -146 to -149
## Release improvements for next time

< Add any release improvements that were observed this cycle here so they can get incorporated into future releases. >

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're capturing these in a release retro doc and the release issue template update PR (like this one) instead, right?

Comment on lines -150 to -153
## 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. >

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what these are supposed to be and I couldn't find this section filled out in the past releases.

Comment on lines 154 to 160
### Changelog

< changelog generated by bin/mkreleaselog > (add it to a separated comment if it is too big)

### ❤️ Contributors

< list generated by bin/mkreleaselog >
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose to comment with a link to the final release on the release issue instead. The final release will already have this information.

@galargh
Copy link
Contributor Author

galargh commented Oct 12, 2022

  1. Table of contents links don't work
  2. Sections like "Hardened IPNS record verification" seem to have odd line breaks.

@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.

@galargh galargh marked this pull request as ready for review October 12, 2022 11:41
Copy link
Member

@ajnavarro ajnavarro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

docs/RELEASE_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
docs/RELEASE_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
docs/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
docs/RELEASE_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
docs/RELEASE_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
docs/RELEASE_ISSUE_TEMPLATE.md Show resolved Hide resolved
docs/RELEASE_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
docs/RELEASE_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
Copy link
Contributor

@BigLep BigLep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - let's go ahead and merge!

@galargh galargh merged commit 0f44f29 into master Oct 20, 2022
@hacdias hacdias deleted the docs-release-0.16.0 branch May 9, 2023 11:04
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

Successfully merging this pull request may close these issues.

4 participants