Add a secret-scanning workflow
Runs gitleaks on pushes to main and on pull requests. The settings file pull_config.sh produces holds API keys in plain text, and .gitignore covers the default filename, but nothing catches a rename or a key in a test fixture. .gitleaks.toml allowlists one path: the constant in app/apps/evenhub/even-api.ts that matches the generic-api-key rule. Scoped by path rather than disabling the rule, so everything else is still scanned.
This commit is contained in:
2 files changed
+31
No files matched your search
@@ -0,0 +1,22 @@
|
||||
name: Secret scan
|
||||
|
||||
# Scans for committed secrets on pushes to main and on pull requests.
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
gitleaks:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: gitleaks/gitleaks-action@v2
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -0,0 +1,9 @@
|
||||
# Secret-scanning config for the workflow in .github/workflows/secret-scan.yml.
|
||||
[extend]
|
||||
useDefault = true
|
||||
|
||||
[[rules]]
|
||||
id = "generic-api-key"
|
||||
[rules.allowlist]
|
||||
description = "SIGN_KEY in even-api.ts is a client-side constant the app needs to sign EvenHub requests, not a credential."
|
||||
paths = ['''app/apps/evenhub/even-api\.ts''']
|
||||
Reference in new issue
Block a user