Add pre-commit hooks for maintaining version match#579
Open
dncrews wants to merge 1 commit into
Open
Conversation
This was referenced Nov 21, 2025
Collaborator
|
I'll leave this PR open for comment, but my initial thoughts are captured here and explain why I'm not merging this right now: #578 (comment) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pre-commit Hook for Version Synchronization
Summary
Adds automated version synchronization using pre-commit hooks to ensure version consistency
across all project files.
Problem
The project maintains version references in multiple files (
package.json,markdownlint.js,README.md,.pre-commit-hooks.yaml). When updating versions, it's easy to miss updating one or more files, leading to inconsistencies.See dncrews#2 for a demonstration where tests pass (because
package.jsonandmarkdownlint.jsmatch) but the pre-commit hook correctly fails becauseREADME.mdand.pre-commit-hooks.yamlweren't updated.Solution
package.jsonbefore each commitChanges
.pre-commit-config.yamlwith version sync hook.github/scripts/sync-version-on-commit.mjsto handle version synchronization.github/workflows/pre-commit.ymlto run hooks in CIREADME.mdwith contributor setup instructionsHow It Works
When any version-related file is modified:
package.json(source of truth)Benefits
Next Steps
For maintainers: To make this check mandatory, add
pre-commitas a required status check in the branch protection rules formaster(Settings → Branches → Branch protection rules).