mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-13 14:32:03 +00:00
Marc-André Bombeck
5b5b5fcc03
The commit-msg hook listed the tools and the session link format it refused, so the file read as a description of how commits are written. It now states the rule: commits are authored by the maintainer's identity, and a co-author trailer is only for a contributor. It refuses a generator line, any "<Word>-Session:" trailer and a co-author trailer whose address is not a GitHub noreply address, so a contributor's credit still passes.
53 lines
2.4 KiB
YAML
53 lines
2.4 KiB
YAML
# Git-hook manager (v1.16.4). `pnpm install` wires the hooks via the
|
|
# `prepare` script in package.json; no manual step needed.
|
|
#
|
|
# Pre-commit secret scan: `gitleaks protect --staged` scans exactly the
|
|
# staged hunks against the repo's `.gitleaks.toml` before every commit,
|
|
# so a secret-shaped string never reaches the object store (where only
|
|
# a history rewrite can remove it again).
|
|
#
|
|
# Requirements: the `gitleaks` binary must be on PATH — the command
|
|
# below fails with install pointers when it is missing rather than
|
|
# silently skipping the scan.
|
|
#
|
|
# Opt-out (one commit): LEFTHOOK=0 git commit ...
|
|
# Opt-out (skip one job): LEFTHOOK_EXCLUDE=gitleaks git commit ...
|
|
# Opt-out (permanent): pnpm lefthook uninstall
|
|
# Per project policy (`--no-verify` is banned), prefer fixing the
|
|
# finding over bypassing the hook.
|
|
|
|
# Commit messages. Commits are authored by the maintainer's git identity;
|
|
# a co-author trailer is only for a contributor whose work is in the
|
|
# commit, under their GitHub noreply address. A message is refused when it
|
|
# carries a "Generated with" / "Generated by" line, a "<Word>-Session:"
|
|
# trailer, or a co-author trailer with any other address.
|
|
commit-msg:
|
|
commands:
|
|
message-trailers:
|
|
run: |
|
|
msg="{1}"
|
|
if grep -qiE '^[^[:alnum:]]*Generated (with|by)[[:space:]]' "$msg" ||
|
|
grep -qiE '^[[:alpha:]]+-Session:' "$msg" ||
|
|
grep -iE '^Co-authored-by:' "$msg" |
|
|
grep -qviE '<[^<>[:space:]]+@users\.noreply\.github\.com>[[:space:]]*$'; then
|
|
echo "ERROR: the commit message carries a generator line, a session trailer," >&2
|
|
echo "or a co-author trailer without a GitHub noreply address." >&2
|
|
echo "Remove the offending line(s) from the message and commit again." >&2
|
|
exit 1
|
|
fi
|
|
|
|
pre-commit:
|
|
commands:
|
|
gitleaks:
|
|
run: |
|
|
if ! command -v gitleaks >/dev/null 2>&1; then
|
|
echo "ERROR: gitleaks binary not found on PATH — the staged-secret scan cannot run." >&2
|
|
echo "Install it first, e.g.:" >&2
|
|
echo " brew install gitleaks # macOS" >&2
|
|
echo " apt/apk/pacman install gitleaks # Linux distros" >&2
|
|
echo " https://github.com/gitleaks/gitleaks#installing" >&2
|
|
echo "One-off bypass (use sparingly): LEFTHOOK=0 git commit ..." >&2
|
|
exit 1
|
|
fi
|
|
gitleaks protect --staged --redact --no-banner
|