Skip to content

Record what the ggshield config does and does not reach - #31

Merged
imanimanyara merged 2 commits into
mainfrom
docs/gitguardian-scope-note
Nov 7, 2026
Merged

imanimanyara merged 2 commits into
mainfrom
docs/gitguardian-scope-note

Conversation

@imanimanyara

Copy link
Copy Markdown
Member

Summary

.gitguardian.yaml is read by the ggshield CLI. It does not configure the
GitGuardian GitHub App, whose GitGuardian Security Checks run on a pull
request is scanned server-side with its exemptions held in the dashboard. That
is why the 2026-11-07 finding had to be resolved in the dashboard while this
file already existed in the repository.

Measured 2026-11-07: no workflow runs ggshield — 429 workflow files
across laranail/packages and simtabi/packages, plus the 8 reusable
workflows in laranail/.github, none referencing it. So the six entries have
no consumer in CI today.

Fixing the key spelling in #30 was still right — a wrong key is wrong wherever
something does read it — but the file as written implied a CI-level control it
does not provide. This records the scope so the next reader does not take a
green GitGuardian check as evidence that an entry here applied.

Comment-only; the YAML parses and secret still carries exactly
ignored_matches, ignored_paths, show_secrets.

Open question for the owner

Whether these files should gain a real CI consumer (a ggshield secret scan
step) is an estate-wide decision — it needs a GITGUARDIAN_API_KEY org secret,
which only you can create, and it duplicates what the App already reports. Not
proposed here.

The file is read by the ggshield CLI, so it governs a local or manual
`ggshield secret scan`. It does not configure the GitGuardian GitHub App,
whose check on a pull request is scanned server-side with its exemptions
held in the dashboard -- which is why the 2026-11-07 finding had to be
resolved there while this file already existed here.

Measured the same day: no workflow runs ggshield, across 429 workflow
files in laranail/packages and simtabi/packages plus the 8 reusable
workflows in laranail/.github. The entries therefore have no consumer in
CI today, so a green GitGuardian check is not evidence that one of them
applied. Correcting the key spelling was still right; the note stops the
next reader mistaking the file for a CI-level control.
Copilot AI balanced review requested due to automatic review settings November 7, 2026 12:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

`plaintext-secret` sat in the group headed "still on KEY=value lines in
the current tree, so these are the entries actually doing work". It is
not in the tree at all -- #23 removed it -- and survives only in three
commits of history, so it belonged in the second group. An exemption
whose stated reason is wrong is a licence rather than a ceiling.

Re-measured every entry while here. The other five are correctly placed:
`plaintext` is at EncryptCliTest.php:11 and `oldsecret` at
AuditTest.php:128, both still on assignment lines; `hunter2`, `newsecret`
and `redaction-canary-not-a-secret` are in the tree but on no assignment
line. Each line now names where its value actually is.
@imanimanyara
imanimanyara merged commit 6c2d42d into main Nov 7, 2026
4 checks passed
@imanimanyara
imanimanyara deleted the docs/gitguardian-scope-note branch November 7, 2026 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants