Skip to content

Conversation

samspills
Copy link
Contributor

Polished up some notes from our call today working through the http4s release. Do these make sense?

@samspills samspills self-assigned this Sep 9, 2024
@samspills samspills changed the title notes on how to put together a 0.23 release notes on how to put together a v0.23.xx release Sep 9, 2024
@mergify mergify bot added the series/0.23 PRs targeting 0.23.x label Sep 9, 2024
Copy link
Member

@valencik valencik left a comment

Choose a reason for hiding this comment

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

Nice! This has all the point from my own notes :)
Thanks for putting this together.

Co-authored-by: Andrew Valencik <valencik@users.noreply.github.com>
Copy link
Member

@rossabaker rossabaker left a comment

Choose a reason for hiding this comment

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

👍 Thanks!

1. Press the "Generate new release notes" button in GitHub.
1. Manually edit the generated release notes:
- Review the auto-labeling and categorization of PRs.
- Put "Behind the scenes" section in to a `details` block.
Copy link
Member

Choose a reason for hiding this comment

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

I think this could be automated in the template, but it's not yet.

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 took a look at the docs and I think the category titles and labels (and an author exclusion) is the only configuration we have. I don't see a way to add anything to a particular category body
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options

Co-authored-by: Ross A. Baker <ross@rossabaker.com>
@samspills samspills merged commit 166ae63 into series/0.23 Sep 9, 2024
34 checks passed
@samspills samspills deleted the sam/releasing-notes branch September 9, 2024 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
series/0.23 PRs targeting 0.23.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants