docs: fix the service-yaml-check invocation path and stale rev pins - #6
Merged
Conversation
The README told readers to call `hooks/service-yaml-check.py <paths>` directly. That file does not exist — the Python hooks ship as console scripts under `pinpredict_hooks/`, which is exactly the regression the same README warns about two sections later. - Point the out-of-pre-commit invocation at the `service-yaml-check` console script, and cross-link the packaging rule in Repository layout. - Bump the three `rev:` examples to v0.4.0; they were showing v0.3.0 and v0.2.0 against a repo tagged v0.4.0, and state the current release once so it has a single home. - Make Releasing say to bump `pyproject.toml` in the same PR as the hook change, and explain why: `language: python` pip-installs the package, so a tag cut without the bump ships a self-reported version that disagrees with the `rev:` it came from. - Note that no repo currently consumes csharpier-worktree-guard, so changes to it are unexercised in practice. - Add the CI workflow to the Repository layout table.
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
1 participant
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.
Why
The README told readers to invoke
service-yaml-checkby callinghooks/service-yaml-check.py <paths>directly. There is no such file — the Python hooks ship as console scripts underpinpredict_hooks/. That's the same regression this README explicitly warns about two sections down ("Python hooks must be console scripts"), documented into the usage instructions.The
rev:examples were also a release behind: three of them pinnedv0.3.0/v0.2.0against a repo taggedv0.4.0.What changed
service-yaml-checkinvocation now points at the console script (pinpredict_hooks/service_yaml_check.py), says plainly that there is nohooks/service-yaml-check.pyto run, and links the packaging rule under Repository layout so the two stay connected.rev:examples bumped tov0.4.0in all three places, plus a single statement of the current release so future bumps have one home.pyproject.tomlin the same PR as the hook change, then cut the matching tag — and explains the failure mode:language: pythonpip-installs this repo, so a tag cut without the bump ships a package whose self-reported version disagrees with therev:it came from, which is invisible until someone checks.csharpier-worktree-guard: notes that no repo currently consumes it, so changes to it are unexercised in practice..github/workflows/ci.ymlrow (unit tests plus thehook-installjob that exercises the pre-commit install path).Reviewer note — not fixed here
pyproject.tomlstill declaresversion = "0.3.0"while the repo is taggedv0.4.0. That's precisely the drift the new Releasing section warns about, and it's live right now. I've left it alone rather than bump a version in a docs-only PR — worth a follow-up that either correctspyproject.tomlto0.4.0or cutsv0.5.0with the two in lockstep.Docs only — no hook behavior changes.