fix: don't include chore PRs in changelog #1810
Conversation
michaelfaith
force-pushed
the
fix/dont-include-chore-changes-in-changlog
branch
from
aaf3f02 to
01a55e2
Compare
This change adjusts the release-it config for both this repo, as well as what the create script generates, so that only three categories of changes are included in the changelog entries: feat, fix, and perf. The idea being that these are the only three types of changes that are generally user-facing.
michaelfaith
force-pushed
the
fix/dont-include-chore-changes-in-changlog
branch
from
01a55e2 to
7e859df
Compare
package.json
Outdated
| "test:create": "npx tsx script/create-test-e2e.ts", | ||
| "test:initialize": "npx tsx script/initialize-test-e2e.ts", | ||
| "test:create": "tsx script/create-test-e2e.ts", | ||
| "test:initialize": "tsx script/initialize-test-e2e.ts", |
There was a problem hiding this comment.
fyi @michaelfaith I removed these changes before merging - but if you think they're good I'm interested in learning more
There was a problem hiding this comment.
yeah, no worries. That was unrelated. I thought it might have been missed in some repo migration from npm to pnpm. It seemed strange that everything used pnpm except for these two scripts, which didn't really need npx either, since tsx is installed locally. Unless you're wanting to allow people to run those scripts without needing to install pnpm or any dependencies? But yeah, it was unrelated to this change; just something I noticed, while testing the changes I made.
| { "hidden": true, "type": "docs" }, | ||
| { "hidden": true, "type": "refactor" }, | ||
| { "hidden": true, "type": "style" }, | ||
| { "hidden": true, "type": "test" } |
There was a problem hiding this comment.
[Praise] I appreciate you alphabetizing these 😁
|
@all-contributors please add @michaelfaith for code.
|
|
I've put up a pull request to add @michaelfaith! 🎉 |
Adds @michaelfaith as a contributor for code. This was requested by JoshuaKGoldberg [in this comment](#1810 (comment)) --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
This change brings over the update from CTA, allowing for cleaner changelog generation JoshuaKGoldberg/create-typescript-app#1810
<!-- 👋 Hi, thanks for sending a PR to package-json-validator! 💖. 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/package-json-validator/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/package-json-validator/blob/main/.github/CONTRIBUTING.md) were taken ## Overview There wasn't an issue for this 😬, but I thought you might want to carry this over from the template update, allowing for cleaner changelog generation JoshuaKGoldberg/create-typescript-app#1810 Happy to also cascade this to eslint-plugin-package-json as well If not, no worries, I just noticed a ton of chore entries in the last release 😁
<!-- 👋 Hi, thanks for sending a PR to eslint-plugin-package-json! 💖. 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-plugin-package-json/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CONTRIBUTING.md) were taken ## Overview This change backports this update to CTA: JoshuaKGoldberg/create-typescript-app#1810 reducing the categories that release-it shows in changelog updates.
|
@michaelfaith I still see this on the Releases page. But in the original issue, it was mentioned that such categories should also be excluded from Releases, not only from CHANGELOG. Or am I missing something? |
The changes in this PR only impact what's added to the changelog. That config is for the conventional changelog plugin. I'll take a look and see if there's similar config for the gh release page. Those are two different underlying tools. |
|
Yeah, looking at the docs for the gh config, there isn't the same level of awareness of the groups. The conventional commits commit format (e.g. feat: title) that's used to generate the changelog is something that's specific to conventional commits. The gh release page just does a simple git diff and dumps everything into the page. It doesn't have the same level of commit subject parsing. It does allow you to pass in a custom function to generate the release page, so we could effectively re-create the same behavior as conventional changelog ourselves, if you think it's worth it. https://github.com/release-it/release-it/blob/main/docs/github-releases.md#function |
|
@JoshuaKGoldberg since this didn't solve both sides of the original issue, do you think it's worth re-opening it? (the changelog sure looks nice though 😅) |
|
How about opening another issue? This one is getting kind of long to read through. |
PR Checklist
status: accepting prsOverview
This change adjusts the release-it config for both this repo, as well as what the create script generates, so that only three categories of changes are included in the changelog entries: feat, fix, and perf. The idea being that these are the only three types of changes that are generally user-facing.
Tested locally with some dummy
chorecommits that I undid after.Closes: #1493