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

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion .release-it.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,19 @@
"plugins": {
"@release-it/conventional-changelog": {
"infile": "CHANGELOG.md",
"preset": "angular"
"preset": "angular",
"types": [
{ "section": "Features", "type": "feat" },
{ "section": "Bug Fixes", "type": "fix" },
{ "section": "Performance Improvements", "type": "perf" },
{ "hidden": true, "type": "build" },
{ "hidden": true, "type": "chore" },
{ "hidden": true, "type": "ci" },
{ "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 😁

]
}
}
}
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
"lint:spelling": "cspell \"**\" \".github/**/*\"",
"prepare": "husky",
"test": "vitest",
"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.

"test:migrate": "vitest run -r script/",
"tsc": "tsc"
},
Expand Down
12 changes: 12 additions & 0 deletions src/next/blocks/blockReleaseIt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,18 @@ export const blockReleaseIt = base.createBlock({
"@release-it/conventional-changelog": {
infile: "CHANGELOG.md",
preset: "angular",
types: [
{ section: "Features", type: "feat" },
{ section: "Bug Fixes", type: "fix" },
{ section: "Performance Improvements", type: "perf" },
{ hidden: true, type: "build" },
{ hidden: true, type: "chore" },
{ hidden: true, type: "ci" },
{ hidden: true, type: "docs" },
{ hidden: true, type: "refactor" },
{ hidden: true, type: "style" },
{ hidden: true, type: "test" },
],
},
},
}),
Expand Down
4 changes: 2 additions & 2 deletions src/steps/writing/creation/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@ describe("createStructure", () => {
scripts: {
initialize:
"pnpm build --no-dts && tsx ./bin/index.js --mode initialize",
"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",
"test:migrate": "vitest run -r script/",
},
},
Expand Down
12 changes: 12 additions & 0 deletions src/steps/writing/creation/rootFiles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,18 @@ export async function createRootFiles(options: Options) {
"@release-it/conventional-changelog": {
infile: "CHANGELOG.md",
preset: "angular",
types: [
{ section: "Features", type: "feat" },
{ section: "Bug Fixes", type: "fix" },
{ section: "Performance Improvements", type: "perf" },
{ hidden: true, type: "build" },
{ hidden: true, type: "chore" },
{ hidden: true, type: "ci" },
{ hidden: true, type: "docs" },
{ hidden: true, type: "refactor" },
{ hidden: true, type: "style" },
{ hidden: true, type: "test" },
],
},
},
}),
Expand Down
Loading