Skip to content

Commit

Permalink
fix: don't include chore PRs in GH release page
Browse files Browse the repository at this point in the history
This change adjusts the release-it config for both this repo, as well as what the create script generates, so that the previous changes to enhance the changelog generation flows through to the github release page too.

I discussed this here release-it/release-it#1025 (comment), and @webpro theorized it was the autoGenerate that overrode the changelog output from being applied to the GH release too.

I created a test repo to verify and confirmed that removing `autoGenerate`, indeed, fixed the issue: https://github.com/michaelfaith/mf-cta-testing/releases
2.0.2 is after this change, which included both a chore change and fix change, but changelog and GH release page only show the bug fix (notice also the group heading, which isn't in the previous releases). 2.0.1 is before the change, with the original configuration
  • Loading branch information
michaelfaith committed Jan 31, 2025
1 parent fb3558f commit 2163f0c
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 6 deletions.
6 changes: 1 addition & 5 deletions .release-it.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@
"commitMessage": "chore: release v${version}",
"requireCommits": true
},
"github": {
"autoGenerate": true,
"release": true,
"releaseName": "v${version}"
},
"github": { "release": true, "releaseName": "v${version}" },
"npm": { "publishArgs": ["--access public", "--provenance"] },
"plugins": {
"@release-it/conventional-changelog": {
Expand Down
1 change: 0 additions & 1 deletion src/blocks/blockReleaseIt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@ export const blockReleaseIt = base.createBlock({
requireCommits: true,
},
github: {
autoGenerate: true,
release: true,
releaseName: "v${version}",
},
Expand Down

0 comments on commit 2163f0c

Please sign in to comment.