Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

Adds a CI check that validates the help output in README.md matches uv run gimmegit -h to prevent documentation drift.

Changes

  • scripts/check_help_consistency.py: Extracts help text from README.md's "# Command reference" section and compares against live gimmegit -h output. Exits with detailed diff on mismatch.

  • .github/workflows/checks.yaml: Added "Check help consistency" step after unit tests, runs via uv run python for dependency consistency.

The check will catch any future changes to _help.py that aren't reflected in README.md.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 19, 2025 04:29
Co-authored-by: dwilding <1141260+dwilding@users.noreply.github.com>
Co-authored-by: dwilding <1141260+dwilding@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 19, 2025

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • astral.sh
    • Triggering command: /usr/bin/curl curl -LsSf REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Add comprehensive help documentation for gimmegit ci: add automated check for help output consistency with README Dec 19, 2025
Copilot AI requested a review from dwilding December 19, 2025 04:32
@dwilding dwilding closed this Dec 19, 2025
@dwilding dwilding deleted the copilot/sub-pr-69 branch December 19, 2025 08:08
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