Skip to content

Commit f7a07ff

Browse files
committed
Update qb-security docs: no secrets needed for TruffleHog
TruffleHog action now downloads its own binary and scans the local checkout, so neither secrets: inherit nor GITHUB_TOKEN is required in the calling workflow.
1 parent a6e3e7f commit f7a07ff

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

docs/qb-security/explanation.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,23 @@ on:
2626
pull_request:
2727

2828
jobs:
29+
# Invisible Unicode detection — no secrets needed
2930
security:
3031
uses: QuickBirdEng/workflows/.github/workflows/qb-security.yml@main
31-
secrets: inherit
32+
33+
# Secret scanning — separate job, passes only the token it needs
34+
trufflehog-scan:
35+
runs-on: default-k8s-runner
36+
steps:
37+
- uses: actions/checkout@v4
38+
with:
39+
fetch-depth: 0
40+
- uses: QuickBirdEng/actions/trufflehog-scan@main
41+
env:
42+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3243
```
3344
34-
That is the minimal setup. `secrets: inherit` is required for the TruffleHog job to access `GITHUB_TOKEN`.
45+
The unicode scan requires no secrets. TruffleHog runs as a separate job and receives only `GITHUB_TOKEN` — no `secrets: inherit` needed.
3546

3647
## Inputs
3748

docs/qb-security/qb-security-calling-example.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,13 @@ on:
66
jobs:
77
security:
88
uses: QuickBirdEng/workflows/.github/workflows/qb-security.yml@main
9-
secrets: inherit
9+
10+
trufflehog-scan:
11+
runs-on: default-k8s-runner
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
- uses: QuickBirdEng/actions/trufflehog-scan@main
17+
env:
18+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)