ci: add automated check for help output consistency with README #72
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.
Adds a CI check that validates the help output in README.md matches
uv run gimmegit -hto prevent documentation drift.Changes
scripts/check_help_consistency.py: Extracts help text from README.md's "# Command reference" section and compares against livegimmegit -houtput. Exits with detailed diff on mismatch..github/workflows/checks.yaml: Added "Check help consistency" step after unit tests, runs viauv run pythonfor dependency consistency.The check will catch any future changes to
_help.pythat aren't reflected in README.md.💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.