ci: fix the release it config to only show user-facing changes #789
Conversation
This change adjusts the release it config so that the output generated from the changelog plugin is used for the github release page. I discussed this here release-it/release-it#1025 (comment), and @webpro theorized it was the autoGenerate that overrode the changelog output. I created a test repo to verify and confirmed that that, did indeed fix the issue: https://github.com/michaelfaith/mf-cta-testing/releases 2.0.2 is after this change, which included both a chore change and fix change, but changelog and GH release page only showed the bug fix (notice also the group heading)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Compliance Checks
Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.
Issue Reference
In order to be considered for merging, the pull request description must refer to a specific issue number. This is described in our Contributing Guide. We are closing this pull request for now but you can update the pull request description and reopen the pull request.
The check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this PR is meant to address.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #789 +/- ##
=======================================
Coverage 98.71% 98.71%
=======================================
Files 19 19
Lines 1163 1163
Branches 139 139
=======================================
Hits 1148 1148
Misses 15 15 ☔ View full report in Codecov by Sentry. |
This change adjusts the release it config so that the output generated from the changelog plugin is used for the github release page. Using autoGenerate overrides the output from the changelog plugin from making it onto the GH release. Ref: JoshuaKGoldberg/eslint-plugin-package-json#789
<!-- 👋 Hi, thanks for sending a PR to eslint-fix-utils! 💖. Please fill out all fields below and make sure each item is true and [x] checked. Otherwise we may not be able to review your PR. --> ## PR Checklist - [ ] Addresses an existing open issue: fixes #000 - [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/eslint-fix-utils/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-fix-utils/blob/main/.github/CONTRIBUTING.md) were taken ## Overview This change adjusts the release it config so that the output generated from the changelog plugin is used for the github release page. Using autoGenerate overrides the output from the changelog plugin from making it onto the GH release. Ref: JoshuaKGoldberg/eslint-plugin-package-json#789
|
🎉 This is included in version v0.22.0 🎉 The release is available on: Cheers! 📦🚀 |
PR Checklist
status: accepting prsOverview
This change adjusts the release it config so that the output generated from the changelog plugin is used for the github release page.
I discussed this here release-it/release-it#1025 (comment), and @webpro theorized it was the autoGenerate that overrode the changelog output.
I created a test repo to verify and confirmed that that did, indeed, fix the issue: https://github.com/michaelfaith/mf-cta-testing/releases
2.0.2 is after this change, which included both a chore change and fix change, but changelog and GH release page only showed the bug fix (notice also the group heading). 2.0.1 is before the change, with the original configuration
The change to the pnpm-lock was necessary to get builds green. Apparently renovate bot broke our lock file in #783