commitbrief/.pre-commit-hooks.yaml at main · CommitBrief/commitbrief · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# pre-commit framework manifest (https://pre-commit.com) — EC1, ADR-0027 ecosystem note.
#
# This is the manifest that the pre-commit.com tool reads when a user adds
# CommitBrief to their .pre-commit-config.yaml. It is DISTINCT from
# `commitbrief install-hook`, which writes a native script into
# .git/hooks/{pre-commit,commit-msg,pre-push}. Pick one:
#
#   - pre-commit framework (this file): one-line entry in an existing
#     .pre-commit-config.yaml; the framework installs/manages the binary.
#   - `commitbrief install-hook`: no framework, a plain git hook script.
#
# Two ids are published so users on either footing can opt in:
#
#   - commitbrief         language: golang  — the documented default. The
#       pre-commit framework builds the binary from this repo in an isolated
#       environment, so a true one-line add works with no prior install.
#   - commitbrief-system  language: system  — uses an already-installed
#       `commitbrief` on PATH (Homebrew / Scoop / `go install`), for users
#       who don't want pre-commit to manage a Go toolchain.
#
# Both run the review gate against the STAGED diff and fail the commit on a
# high-or-worse finding. The hook runs non-interactively (no TTY): the
# pre-send secret scanner ABORTS on a non-TTY detection rather than prompting,
# so a leaked credential blocks the commit. `--yes` does NOT bypass the secret
# scan. To raise/lower the gate, override `args` in your .pre-commit-config.yaml,
# e.g. `args: [--staged, --fail-on=critical]`.
#
# Example .pre-commit-config.yaml entry:
#
#   repos:
#     - repo: https://github.com/CommitBrief/commitbrief
#       rev: v1.8.0
#       hooks:
#         - id: commitbrief

- id: commitbrief
  name: CommitBrief (AI code review)
  description: Run a local LLM code review on the staged diff and block the commit on a high-severity finding.
  entry: commitbrief
  args: [--staged, --fail-on=high]
  language: golang
  pass_filenames: false
  stages: [pre-commit]

- id: commitbrief-system
  name: CommitBrief (AI code review, system binary)
  description: Same as `commitbrief` but uses an already-installed binary on PATH instead of building from source.
  entry: commitbrief
  args: [--staged, --fail-on=high]
  language: system
  pass_filenames: false
  stages: [pre-commit]