Skip to content

docs: make lefthook prepare script tolerate a missing binary in CI #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
taraxvoid wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: make lefthook prepare script tolerate a missing binary in CI #131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,17 @@ scripts: define `test:unit:precommit` (for example excluding tests that need a
built `dist/`) and the pre-commit unit step runs it instead of `test:unit`.

Install the binary through mise (`lefthook = "<version>"` in `mise.toml`) and
set `"prepare": "lefthook install"` so `bun install` wires the hooks. `ref`
cannot be a commit SHA; pin a release tag.
set the `prepare` script so `bun install` wires the hooks, but make it tolerate a
missing binary:

```json
"prepare": "lefthook install || echo 'lefthook not installed (run mise install); git hooks skipped'"
```

A bare `lefthook install` fails the whole install step (exit 127) on any runner
without the `lefthook` binary, which includes GitHub-hosted and self-hosted CI
images, and CI never runs git hooks anyway. `ref` cannot be a commit SHA; pin a
release tag.

## Branch rulesets as code

Expand Down
Loading