ci: add gitleaks secret-scan job (compliance #171) by don-petry · Pull Request #215 · petry-projects/google-app-scripts

don-petry · 2026-04-19T21:38:49Z

Summary

Adds the required secret-scan job to .github/workflows/ci.yml per the org push-protection standard
Resolves the secret_scan_ci_job_present compliance finding from issue Compliance: secret_scan_ci_job_present #171
Pins both actions to SHA per the Action Pinning Policy

What was added

secret-scan:
  name: Secret scan (gitleaks)
  runs-on: ubuntu-latest
  permissions:
    contents: read
    security-events: write
  steps:
    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        fetch-depth: 0
    - uses: gitleaks/gitleaks-action@ff98106e4c7b2bc287b24eaf42907196329070c7 # v2.3.9
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE }}

Why this PR over #198

PR #198 had the correct action reference but CI failed because GITLEAKS_LICENSE was not passed in the env: block. gitleaks-action@v2 requires this for organization repos. This PR adds GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE }} — if the org secret is configured, CI will pass.

If CI still fails on "Secret scan (gitleaks)": the GITLEAKS_LICENSE secret needs to be added at the org or repo level (obtain from gitleaks.io).

Compliance check satisfied

The weekly audit greps for uses: gitleaks/gitleaks-action@ in ci.yml — this PR satisfies that check.

Closes #171

Generated with Claude Code

Summary by CodeRabbit

Chores
- Enhanced CI/CD pipeline with automated secret scanning to improve repository security.

Adds the required `secret-scan` job per the org push-protection standard (standards/push-protection.md#layer-3--ci-secret-scanning-secondary-defense). The job: - Checks out full git history (fetch-depth: 0) for complete scan coverage - Runs gitleaks/gitleaks-action@v2.3.9 pinned to SHA ff98106e4c7b2bc287b24eaf42907196329070c7 - Passes --redact to prevent secrets appearing in logs - Passes --exit-code 1 to fail the build on any finding - Passes GITLEAKS_LICENSE from secrets to satisfy the org-repo license requirement (prior attempt PR #198 omitted this env var, causing the CI failure) Resolves the `secret_scan_ci_job_present` compliance finding. Co-authored-by: don-petry <don-petry@users.noreply.github.com>

coderabbitai · 2026-04-19T21:38:56Z

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Added a new secret-scan job to the CI workflow that performs gitleaks scanning. The job checks out the repository with full history and runs gitleaks with redaction and verbose output, configured to fail on detected secrets using repository secrets and appropriate permissions.

Changes

CI Security Scanning

Layer / File(s)	Summary
Workflow Job Configuration `.github/workflows/ci.yml`	New `secret-scan` job added with full repository history checkout, gitleaks detection with `--redact --verbose --exit-code 1`, and `security-events: write` permission for reporting findings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: adding a gitleaks secret-scan job to CI configuration to address compliance requirement `#171`.
Linked Issues check	✅ Passed	The PR implements the required secret-scan job per issue `#171` requirements, using gitleaks-action with proper configuration including fetch-depth: 0, GITLEAKS_LICENSE secret, and appropriate permissions.
Out of Scope Changes check	✅ Passed	The changes are limited to adding the secret-scan CI job to .github/workflows/ci.yml as specified in the linked compliance issue, with no unrelated modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch claude/issue-171-20260419-2133

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Review rate limit: 0/1 reviews remaining, refill in 60 minutes.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

don-petry · 2026-04-19T21:41:16Z

@don-petry — this PR implements the secret-scan job per the org standard and satisfies the secret_scan_ci_job_present compliance check. However, there is an infrastructure blocker preventing CI from passing.

CI failure: missing GITLEAKS_LICENSE

gitleaks-action@v2 requires a paid GITLEAKS_LICENSE for organization repos. The secret is not configured at the org or repo level:

[petry-projects] is an organization. License key is required.
🛑 missing gitleaks license. Go grab one at gitleaks.io

To unblock

Obtain a GITLEAKS_LICENSE from gitleaks.io (free tier available for open-source)
Add it as an org-level secret: Org settings → Secrets and variables → Actions → New organization secret named GITLEAKS_LICENSE
Re-run the failed "Secret scan (gitleaks)" job — it will pass once the secret is available
Merge this PR

Once merged, the secret_scan_ci_job_present compliance finding on issue #171 will be resolved on the next weekly audit.

Note: PRs #190 and #198 are superseded by this one and can be closed.

Copilot

Pull request overview

Adds a new CI job to run Gitleaks secret scanning to satisfy org push-protection compliance requirements and address issue #171.

Changes:

Add a secret-scan job to .github/workflows/ci.yml using gitleaks/gitleaks-action with SHA-pinned actions.
Configure full-history checkout and run gitleaks detect with redaction and failure on findings.
Pass GITLEAKS_LICENSE via workflow env (alongside GITHUB_TOKEN).

Copilot · 2026-04-19T21:41:36Z

+  secret-scan:
+    name: Secret scan (gitleaks)
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write


On pull_request events from forks, secrets.GITLEAKS_LICENSE will not be available and the GITHUB_TOKEN cannot be granted security-events: write, so this job is likely to fail for fork PRs (the rest of this workflow already has fork-specific handling). Consider adding an if: guard to run this job only on pushes and same-repo PRs, or otherwise skipping/uploading conditionally when the license/token permissions aren’t available.

Copilot · 2026-04-19T21:41:36Z

+        # Pin to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).
+        # Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+
+      - name: Run gitleaks
+        # Pinned to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).


The pinning-policy reference points to ci-standards.md#action-pinning-policy, but this repository doesn’t contain ci-standards.md. Update the comment to reference an existing doc/location (e.g., the org standards link in AGENTS.md) or remove it to avoid a dead reference.

Suggested change

# Pin to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).

# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'

uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

fetch-depth: 0

- name: Run gitleaks

# Pinned to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).

# Pin to a commit SHA.

# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'

uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

fetch-depth: 0

- name: Run gitleaks

# Pin to a commit SHA.

Copilot · 2026-04-19T21:41:37Z

+    steps:
+      - name: Checkout (full history)
+        # Pin to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).
+        # Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'


The "Look up current SHA" command references tags/v4, but the workflow is using an action version comment of v6.0.2 (and elsewhere in the repo actions/checkout is annotated as v6). Update the tag in the lookup command (or the version annotation) so maintainers fetch the correct SHA when refreshing pins.

Suggested change

# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'

# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v6.0.2 --jq '.object.sha'

Copilot · 2026-04-19T21:41:37Z

+        # Pin to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).
+        # Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+
+      - name: Run gitleaks
+        # Pinned to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).


This pinning-policy comment again references ci-standards.md#action-pinning-policy, which doesn’t exist in this repo. Align the reference with an existing standard/documentation source so future updates don’t dead-end.

Suggested change

# Pin to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).

# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'

uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

fetch-depth: 0

- name: Run gitleaks

# Pinned to SHA per Action Pinning Policy (ci-standards.md#action-pinning-policy).

# Pin to a full commit SHA per GitHub Actions security hardening guidance:

# https://docs.github.com/en/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions

# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'

uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

fetch-depth: 0

- name: Run gitleaks

# Pinned to a full commit SHA per GitHub Actions security hardening guidance:

# https://docs.github.com/en/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions

sonarqubecloud · 2026-05-03T16:12:17Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copilot AI review requested due to automatic review settings April 19, 2026 21:38

don-petry mentioned this pull request Apr 19, 2026

Compliance: secret_scan_ci_job_present #171

Closed

Copilot started reviewing on behalf of don-petry April 19, 2026 21:39 View session

Copilot AI reviewed Apr 19, 2026

View reviewed changes

github-actions Bot added 2 commits April 21, 2026 04:12

Merge branch 'main' into claude/issue-171-20260419-2133

5b38a3a

Merge branch 'main' into claude/issue-171-20260419-2133

570a95e

Merge branch 'main' into claude/issue-171-20260419-2133

4d86cb8

don-petry mentioned this pull request May 3, 2026

ci: add secret-scan job to ci.yml (issue #171) #241

Closed

ci: trigger build-and-test checks

4db2df7

don-petry merged commit 0979f9d into main May 3, 2026
23 of 25 checks passed

don-petry deleted the claude/issue-171-20260419-2133 branch May 3, 2026 16:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ci: add gitleaks secret-scan job (compliance #171)#215

ci: add gitleaks secret-scan job (compliance #171)#215
don-petry merged 5 commits into
mainfrom
claude/issue-171-20260419-2133

don-petry commented Apr 19, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 19, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Uh oh!

don-petry commented Apr 19, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 19, 2026

Uh oh!

Copilot AI Apr 19, 2026

Uh oh!

Copilot AI Apr 19, 2026

Uh oh!

Copilot AI Apr 19, 2026

Uh oh!

sonarqubecloud Bot commented May 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v4 --jq '.object.sha'
	# Look up current SHA: gh api repos/actions/checkout/git/refs/tags/v6.0.2 --jq '.object.sha'

Uh oh!

Conversation

don-petry commented Apr 19, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What was added

Why this PR over #198

Compliance check satisfied

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Uh oh!

don-petry commented Apr 19, 2026

CI failure: missing GITLEAKS_LICENSE

To unblock

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented May 3, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

don-petry commented Apr 19, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 19, 2026 •

edited

Loading