Skip to content

Commit 7e859df

Browse files
committed
fix: don't include chore PRs in changelog
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.
1 parent 6e81c74 commit 7e859df

File tree

5 files changed

+41
-5
lines changed

5 files changed

+41
-5
lines changed

Diff for: .release-it.json

+13-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,19 @@
1212
"plugins": {
1313
"@release-it/conventional-changelog": {
1414
"infile": "CHANGELOG.md",
15-
"preset": "angular"
15+
"preset": "angular",
16+
"types": [
17+
{ "section": "Features", "type": "feat" },
18+
{ "section": "Bug Fixes", "type": "fix" },
19+
{ "section": "Performance Improvements", "type": "perf" },
20+
{ "hidden": true, "type": "build" },
21+
{ "hidden": true, "type": "chore" },
22+
{ "hidden": true, "type": "ci" },
23+
{ "hidden": true, "type": "docs" },
24+
{ "hidden": true, "type": "refactor" },
25+
{ "hidden": true, "type": "style" },
26+
{ "hidden": true, "type": "test" }
27+
]
1628
}
1729
}
1830
}

Diff for: package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
"lint:spelling": "cspell \"**\" \".github/**/*\"",
3333
"prepare": "husky",
3434
"test": "vitest",
35-
"test:create": "npx tsx script/create-test-e2e.ts",
36-
"test:initialize": "npx tsx script/initialize-test-e2e.ts",
35+
"test:create": "tsx script/create-test-e2e.ts",
36+
"test:initialize": "tsx script/initialize-test-e2e.ts",
3737
"test:migrate": "vitest run -r script/",
3838
"tsc": "tsc"
3939
},

Diff for: src/next/blocks/blockReleaseIt.ts

+12
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,18 @@ export const blockReleaseIt = base.createBlock({
132132
"@release-it/conventional-changelog": {
133133
infile: "CHANGELOG.md",
134134
preset: "angular",
135+
types: [
136+
{ section: "Features", type: "feat" },
137+
{ section: "Bug Fixes", type: "fix" },
138+
{ section: "Performance Improvements", type: "perf" },
139+
{ hidden: true, type: "build" },
140+
{ hidden: true, type: "chore" },
141+
{ hidden: true, type: "ci" },
142+
{ hidden: true, type: "docs" },
143+
{ hidden: true, type: "refactor" },
144+
{ hidden: true, type: "style" },
145+
{ hidden: true, type: "test" },
146+
],
135147
},
136148
},
137149
}),

Diff for: src/steps/writing/creation/index.test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,8 @@ describe("createStructure", () => {
253253
scripts: {
254254
initialize:
255255
"pnpm build --no-dts && tsx ./bin/index.js --mode initialize",
256-
"test:create": "npx tsx script/create-test-e2e.ts",
257-
"test:initialize": "npx tsx script/initialize-test-e2e.ts",
256+
"test:create": "tsx script/create-test-e2e.ts",
257+
"test:initialize": "tsx script/initialize-test-e2e.ts",
258258
"test:migrate": "vitest run -r script/",
259259
},
260260
},

Diff for: src/steps/writing/creation/rootFiles.ts

+12
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,18 @@ export async function createRootFiles(options: Options) {
6868
"@release-it/conventional-changelog": {
6969
infile: "CHANGELOG.md",
7070
preset: "angular",
71+
types: [
72+
{ section: "Features", type: "feat" },
73+
{ section: "Bug Fixes", type: "fix" },
74+
{ section: "Performance Improvements", type: "perf" },
75+
{ hidden: true, type: "build" },
76+
{ hidden: true, type: "chore" },
77+
{ hidden: true, type: "ci" },
78+
{ hidden: true, type: "docs" },
79+
{ hidden: true, type: "refactor" },
80+
{ hidden: true, type: "style" },
81+
{ hidden: true, type: "test" },
82+
],
7183
},
7284
},
7385
}),

0 commit comments

Comments
 (0)