-
-
Notifications
You must be signed in to change notification settings - Fork 80
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
🐛 Bug: GH Release page should only include user-facing changes #1913
Comments
This change is a POC to address JoshuaKGoldberg/create-typescript-app#1913. Since it's not something we can really test locally, I figured we test it out here, and then, if successful, I can make the updates upstream. Here we've changed the release-it config from json to js, which allows us to create a custom function for `github.releaseNotes`. Using the context provided by release-it, we can filter by groups that we want to keep, and organize them into the same groups that we're organizing for the CHANGELOG (via conventional-changelog)
This change is a POC to address JoshuaKGoldberg/create-typescript-app#1913. Since it's not something we can really test locally, I figured we test it out here, and then, if successful, I can make the updates upstream. Here we've changed the release-it config from json to js, which allows us to create a custom function for `github.releaseNotes`. Using the context provided by release-it, we can filter by groups that we want to keep, and organize them into the same groups that we're organizing for the CHANGELOG (via conventional-changelog)
This change is a POC to address JoshuaKGoldberg/create-typescript-app#1913. Since it's not something we can really test locally, I figured we test it out here, and then, if successful, I can make the updates upstream. Here we've changed the release-it config from json to js, which allows us to create a custom function for `github.releaseNotes`. Using the context provided by release-it, we can filter by groups that we want to keep, and organize them into the same groups that we're organizing for the CHANGELOG (via conventional-changelog). I updated the prepare action to use node 22, which will allow us to use the `Object.groupBy` api (introduced in v21). Since 22 is now LTS, this felt like a reasonable change.
@all-contributors please add @michaelfaith for bug.
|
I've put up a pull request to add @michaelfaith! 🎉 |
Adds @michaelfaith as a contributor for bug. This was requested by JoshuaKGoldberg [in this comment](#1913 (comment)) --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Josh Goldberg <[email protected]>
Marking as |
Bug Report Checklist
main
branch of the repository.Expected
#1810 addressed the CHANGELOG side of #1493, but not the GH Release Page. The release pages should similarly only show changes that are user-facing (i.e. not include
chore
PRs).Actual
It currently shows all changes. https://github.com/JoshuaKGoldberg/create-typescript-app/releases/tag/v1.77.1
Additional Info
The gh function of release-it isn't nearly as featureful as the changelog generation (powered by conventional-changelog), so it'll require a bit more manual customization for it to behave similarly. They do provide the ability to pass in a custom function, which could be used to filter out unwanted changes: https://github.com/release-it/release-it/blob/main/docs/github-releases.md#function
e.g.
The text was updated successfully, but these errors were encountered: