Skip to content

Commit

Permalink
fix: don't include chore PRs in changelog (#1810)
Browse files Browse the repository at this point in the history
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
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

- [x] Addresses an existing open issue: fixes #1493
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## 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

---------

Co-authored-by: Josh Goldberg <[email protected]>
  • Loading branch information
michaelfaith and JoshuaKGoldberg authored Dec 26, 2024
1 parent 6e81c74 commit ee8166c
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
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" }
]
}
}
}
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
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

0 comments on commit ee8166c

Please sign in to comment.