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

fix: don't include chore PRs in changelog #1810

Conversation

michaelfaith
Copy link
Contributor

PR Checklist

Overview

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 chore commits that I undid after.

Closes: #1493

@michaelfaith michaelfaith marked this pull request as ready for review December 26, 2024 01:36
@michaelfaith michaelfaith force-pushed the fix/dont-include-chore-changes-in-changlog branch from aaf3f02 to 01a55e2 Compare December 26, 2024 01:46
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 michaelfaith force-pushed the fix/dont-include-chore-changes-in-changlog branch from 01a55e2 to 7e859df Compare December 26, 2024 02:01
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

LGTM, thanks so much! This has been bugging me for the longest time 😄...

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",
Copy link
Owner

Choose a reason for hiding this comment

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

Unrelated changes?

Copy link
Owner

Choose a reason for hiding this comment

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

fyi @michaelfaith I removed these changes before merging - but if you think they're good I'm interested in learning more

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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" }
Copy link
Owner

Choose a reason for hiding this comment

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

[Praise] I appreciate you alphabetizing these 😁

@JoshuaKGoldberg
Copy link
Owner

The migration test failure is tracked in #1811. I'm hoping that the whole system will be removed within the next 1-2 weeks anyway 🤞 (#1181).

@JoshuaKGoldberg JoshuaKGoldberg merged commit ee8166c into JoshuaKGoldberg:main Dec 26, 2024
13 of 14 checks passed
@JoshuaKGoldberg
Copy link
Owner

@all-contributors please add @michaelfaith for code.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

Copy link
Contributor

@JoshuaKGoldberg

I've put up a pull request to add @michaelfaith! 🎉

JoshuaKGoldberg pushed a commit that referenced this pull request Dec 26, 2024
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 Bug: Don't include chore PRs in changelogs and release notes
2 participants