Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/workflows/gitleaks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Gitleaks

on:
pull_request:
branches: [main]
push:
branches: [main]

jobs:
gitleaks:
if: ${{ !contains(github.event.pull_request.labels.*.name, 'no_gha') }}
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Checkout Code
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
with:
fetch-depth: 0

- name: Install gitleaks
env:
GITLEAKS_VERSION: 8.30.1
run: |
curl -sSfL "https://github.com/gitleaks/gitleaks/releases/download/v${GITLEAKS_VERSION}/gitleaks_${GITLEAKS_VERSION}_linux_x64.tar.gz" \
| tar -xz -C /usr/local/bin gitleaks
gitleaks version

- name: Restore gitleaks config from base branch
if: github.event_name == 'pull_request'
run: |
if git show "origin/${{ github.base_ref }}:.gitleaks.toml" 2>/dev/null > .gitleaks.toml.base; then
mv .gitleaks.toml.base .gitleaks.toml
else
rm -f .gitleaks.toml.base
echo "No .gitleaks.toml on base branch; using checked-out copy (bootstrap)."
fi

if git show "origin/${{ github.base_ref }}:.gitleaksignore" 2>/dev/null > .gitleaksignore; then
echo "Loaded .gitleaksignore from base branch."
else
rm -f .gitleaksignore
echo "No .gitleaksignore on base branch; fingerprint suppression disabled."
fi

- name: Scan PR / pushed commits for secrets
env:
BASE_SHA: ${{ github.event.pull_request.base.sha || github.event.before }}
HEAD_SHA: ${{ github.event.pull_request.head.sha || github.sha }}
run: |
if ! git cat-file -e "$BASE_SHA^{commit}" 2>/dev/null; then
BASE_SHA="$HEAD_SHA~1"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Avoid falling back to scanning only the last pushed commit

When BASE_SHA is not present in the checkout, such as a created/recreated main branch or a force-push whose old tip is no longer fetched, this fallback narrows the scan to HEAD_SHA~1..HEAD_SHA. The next command passes that range to Gitleaks via --log-opts, so any secret introduced in earlier commits from the same pushed update is never examined; for a secret scanner, it is safer to fetch the missing base, scan the full reachable history for that push, or fail closed instead of scanning only one commit.

Useful? React with 👍 / 👎.

fi
gitleaks git --no-banner --redact --ignore-gitleaks-allow --config .gitleaks.toml \
--log-opts="$BASE_SHA..$HEAD_SHA"
2 changes: 2 additions & 0 deletions .gitleaks.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[extend]
useDefault = true