Skip to content

chore: move changelog generation to after:bump hook#18

Merged
karmaniverous merged 1 commit into
mainfrom
chore/fix-release-it-changelog-hook
May 12, 2026
Merged

chore: move changelog generation to after:bump hook#18
karmaniverous merged 1 commit into
mainfrom
chore/fix-release-it-changelog-hook

Conversation

@jgs-jeeves
Copy link
Copy Markdown
Collaborator

Move auto-changelog generation from before:npm:release to after:bump so the updated CHANGELOG.md is included in the release commit and tag. Also narrows git add -A to git add CHANGELOG.md to avoid staging unrelated files.

@jgs-jeeves jgs-jeeves requested a review from karmaniverous May 6, 2026 01:06
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the release configuration in package.json by moving the changelog and documentation generation from the before:npm:release hook to a new after:bump hook. Feedback was provided regarding the change from git add -A to git add CHANGELOG.md, which may inadvertently exclude documentation updates generated during the build process from the release commit.

Comment thread package.json
"after:bump": [
"npx auto-changelog -p",
"npm run docs",
"git add CHANGELOG.md"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Narrowing the git add command to only CHANGELOG.md will exclude any documentation updates generated by npm run docs from the release commit. If the documentation (e.g., a docs/ folder) is tracked in the repository and intended to be part of the release, it should be explicitly added here to ensure it stays in sync with the release tag. Since the previous configuration used git add -A, this change might lead to incomplete release commits where the documentation lags behind the version bump.

@karmaniverous karmaniverous merged commit 8acc6c7 into main May 12, 2026
1 check passed
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.

2 participants