Commit d5a8962
committed
docs(checklist): rewrite Section 8 to match the actual .pre-commit-config.yaml
Previous Section 8 was inaccurate. It listed gitleaks as a key hook,
but gitleaks is NOT in the parent repo's .pre-commit-config.yaml -
it's mentioned only in the codebase-security-audit skill's CI
workflow reference. And it omitted lychee (the third actual repo in
the shipped config).
Also, ggshield runs OUTSIDE pre-commit-config.yaml as its own git
hook (you can see "ggshield detected... Running secret scan"
running before the pre-commit hooks in every commit log), so it
needs its own install steps, not a one-line mention buried in a
prose sentence about "key hooks".
New Section 8 mirrors reality:
- Tells the reader to copy the actual file (and .markdownlint.yaml,
which markdownlint --config references)
- Table listing all three repos in the shipped config with their
pinned revs, the hooks each one provides, and what each does
(pre-commit-hooks v6.0.0 with eight hooks; markdownlint-cli v0.47.0
with auto-fix; lychee nightly as a manual-stage link checker)
- Notes the file-specific excludes (trailing-whitespace skips *.md
to preserve hard breaks; end-of-file-fixer skips *.mdc)
- Separate subsection for ggshield with brew/pipx install + ggshield
auth login + ggshield install --mode local --type pre-commit
- Honest note that ggshield COMPLEMENTS detect-private-key (which
only catches a small set of recognized key formats) rather than
replacing it
- Cross-link to the codebase-security-audit skill for users who want
gitleaks-grade coverage in CI rather than in pre-commit
No slop, no smart quotes, no em/en-dashes (verified post-write).1 parent 31c3b5b commit d5a8962
1 file changed
Lines changed: 25 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
145 | 145 | | |
146 | 146 | | |
147 | 147 | | |
148 | | - | |
| 148 | + | |
149 | 149 | | |
150 | 150 | | |
151 | 151 | | |
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
| 155 | + | |
155 | 156 | | |
156 | 157 | | |
157 | 158 | | |
158 | 159 | | |
159 | | - | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
160 | 183 | | |
161 | 184 | | |
162 | 185 | | |
| |||
0 commit comments