docs: refresh stale docs after Homebrew formula and action changes - #42
Merged
Conversation
The README predated several shipped changes: the Homebrew formula (#36), the action's install-only input (#31), and the bench script's move into .github/. It also pointed users at go install without warning that the binary lands as go-pre-commit while the installed hooks exec pre-commit by name. - README: add Homebrew install, document install-only, fix bench path, refresh version examples, note the go install binary-name gotcha, and document that make check does not lint - AGENTS.md: add missing internal/fsutil/ to the structure; drop the hardcoded goreleaser version (drift bait — .tool-versions is the pin) - action.yml: refresh the version input's example string - bench.sh: cd to the repo root, not .github/ — the script was moved there without updating its paths, so it could never find the binary
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.
Audit of README.md / AGENTS.md / CLAUDE.md against the current state of the repo. Most claims checked out (language count, hook types, commands table, CI job table, toolchain pins, action consumers); this fixes what had drifted.
README.md
brew install blairham/tap/pre-commit) — the formula shipped in build: publish a Homebrew formula instead of a cask #36 but was never documentedinstall-onlyaction input (feat(action): add install-only input #31) alongside the other inputsgo install .../v4@latestnames the binarygo-pre-commit, while the installed hook script execspre-commitby namebash .github/bench.sh), refresh stale version examples, expand the release section (signing/notarization, tap update, upstream-parity versioning), and note thatmake checkdoes not lintAGENTS.md
internal/fsutil/directory to the project structure.tool-versionsis the pin and the number is drift baitRelated fixes
action.yml: refresh theversioninput's example string (description only).github/bench.sh: the script was moved from the repo root into.github/without updating itscd, so it looked for the binary at.github/build/pre-commit— cd to the repo root insteadCLAUDE.md was audited and needed no changes. The performance table (benchmarked against Python pre-commit v4.5.1) is left as a historical measurement record.