Skip to content

Commit d3820ef

Browse files
committed
[SCAN-423][chore] Trim secret-scan comments and CONTRIBUTING section
1 parent 82acf67 commit d3820ef

2 files changed

Lines changed: 4 additions & 11 deletions

File tree

.github/workflows/secret-scan-pulse.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# CI secret-scan enforcement via NVIDIA/security-workflows (Pulse).
66
# Runs on Linux nv-gha-runners (Pulse Docker image + OIDC/Vault) — Linux-only by design.
77
# The local secret-scan-trufflehog pre-commit hook is cross-platform (Linux/macOS/Windows via Git Bash).
8-
# Pinned to a reviewed commit SHA; bump when NVIDIA/security-workflows consolidates.
8+
# Pinned to a reviewed commit SHA.
99

1010
name: Secret Scan (Pulse)
1111

@@ -14,21 +14,19 @@ on:
1414
branches:
1515
- main
1616
- ctk-next
17-
# copy-pr-bot mirror branches — trusted PR execution context
1817
- "pull-request/[0-9]+"
1918
workflow_dispatch:
2019

2120
concurrency:
2221
group: ${{ github.workflow }}-on-${{ github.event_name }}-from-${{ github.ref_name }}
2322
cancel-in-progress: true
2423

25-
# Caller must grant at least every permission the reusable workflow declares
26-
# (a reusable workflow requesting more than the caller allows fails at load time).
24+
# Caller must grant every permission the reusable workflow declares.
2725
permissions:
2826
contents: read
2927
id-token: write # OIDC -> Vault -> nvcr.io image pull
3028
security-events: write # publish redacted SARIF to code scanning
31-
actions: read # reusable workflow declares actions: read (upload-sarif)
29+
actions: read
3230

3331
jobs:
3432
secret-scan:

CONTRIBUTING.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,7 @@ warning reminding you to run `pre-commit install`.
7777

7878
## Secret Scanning
7979

80-
Two complementary controls prevent accidental credential leakage:
81-
82-
- **Local pre-commit** (`secret-scan-trufflehog`, via `.pre-commit-config.yaml`): catches credentials before commit. Self-installing — no manual setup beyond `pre-commit install`; the hook downloads a pinned, checksum-verified `trufflehog` on first use. Never commit a flagged secret; check with maintainers on false positives, and only use `git commit --no-verify` in exceptional, agreed cases.
83-
- **Server-side enforcement** (Pulse reusable workflow from `NVIDIA/security-workflows`, pinned by SHA): runs on `main`, `ctk-next`, and trusted copy-pr-bot branches on Linux runners, and blocks merges on verified secrets.
84-
85-
The local hook is skipped on hosted pre-commit.ci (no `trufflehog` binary there); Pulse remains the authoritative CI enforcement. On **Windows**, run the hook from a Git Bash / MSYS shell (bundled with Git for Windows), which the hook requires; the CI (Pulse) control is Linux-runner-only by design.
80+
The `secret-scan-trufflehog` pre-commit hook scans staged files and installs TruffleHog on first run (use Git Bash on Windows). If it flags a secret, remove it before committing, or contact a maintainer if it's a false positive. Secrets are also scanned server-side in CI.
8681

8782

8883
## Signing Your Work

0 commit comments

Comments
 (0)