-
Notifications
You must be signed in to change notification settings - Fork 0
fix: repo review improvements — governance docs, gitleaks, tooling #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # macOS | ||
| .DS_Store | ||
|
|
||
| # Editor / IDE | ||
| .idea/ | ||
| .vscode/ | ||
| *.swp | ||
| *.swo | ||
|
|
||
| # AI tooling (local only) | ||
| .qodo/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| title = "CivicTechWR Gitleaks Config" | ||
|
|
||
| # Inherit all built-in Gitleaks detection rules. | ||
| # Without this, a custom config file disables all default detectors. | ||
| [extend] | ||
| useDefault = true | ||
|
|
||
| # Add allowlist entries below to suppress false positives. | ||
| # Each entry should include a `description` explaining why it is safe. | ||
| # Only add entries after confirming the value is not a real secret. | ||
| # | ||
| # Example: | ||
| # [[allowlist.regexes]] | ||
| # description = "Example placeholder API key in docs" | ||
| # regex = "EXAMPLE_API_KEY_12345" | ||
|
|
||
| [allowlist] | ||
| description = "CivicTechWR global allowlist" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,36 @@ | ||
| # Gitleaks Response Guide | ||
|
|
||
| This guide helps CivicTechWR maintainers triage, contain, and remediate potential secrets flagged by automated Gitleaks scans. | ||
| When this workflow comments on your pull request, it means Gitleaks spotted something that looks like a credential. The build stays green, but secrets must be handled quickly and carefully. | ||
|
|
||
| ## 1. Triage the Finding | ||
| ## Quick Checklist | ||
|
|
||
| - Review the redacted report attached to the workflow run or pull request comment to identify the file and rule triggered. | ||
| - Decide whether the flagged value is a real secret, test data, or a false positive. | ||
| 1. **Stop merging** the pull request until the investigation is complete. | ||
| 2. Open the PR comment or downloaded `gitleaks-report.json` artifact to review the redacted findings. | ||
| 3. Confirm whether each finding is a real secret or a false positive. | ||
| 4. Follow the appropriate section below and leave a short update on the PR comment. | ||
|
|
||
| ## 2. Contain the Exposure | ||
| ## If the Secret Is Real | ||
|
|
||
| - Remove the secret from the repository immediately (revert the change or follow up with a commit that deletes it and uses environment variables or secrets instead). | ||
| - Rotate or invalidate the exposed credential in the affected service (Supabase, Slack, third-party API, etc.). | ||
| - **Rotate / revoke the credential immediately.** Use the relevant provider console (Supabase, Slack, third-party API, etc.) or contact the owner of the secret. | ||
| - **Purge the secret from Git history.** Remove it locally (including from previous commits) and force-push a clean branch. | ||
| - Prefer [`git filter-repo`](https://github.com/newren/git-filter-repo) (or `git filter-branch` as a fallback) to rewrite history. | ||
| - After rewriting history, regenerate the artifact (`git commit --amend` or new commit) and push with `--force-with-lease`. | ||
| - If the secret landed in commit history already merged to the default branch, coordinate with maintainers before rewriting — downstream forks may need notification. | ||
| - **Document replacements.** Update `.env.example` or secrets management notes so others know the new credential. | ||
| - **Confirm the fix.** Run `gitleaks detect --redact` locally to verify the repository is clean before merging. | ||
| - **Update the PR comment.** Reply to the workflow comment summarizing what was rotated and how history was cleaned (no need to paste secrets). | ||
| - **For high-impact secrets** (production credentials, user data access), escalate immediately in the organizers' channel or email `[email protected]`. | ||
|
|
||
| ## 3. Clean the History (If Needed) | ||
| ## If It Is a False Positive | ||
|
|
||
| - If the secret landed in commit history, coordinate with maintainers before rewriting history. | ||
| - Use `git filter-repo` or provider tooling to purge historical references; ensure downstream forks are notified. | ||
| - **Verify carefully.** Make sure the redacted value is truly benign (example: test data, dummy keys, or hashed values). | ||
| - **Mask the pattern going forward.** Add an `allowlist` entry in your repository-level `.gitleaks.toml` and commit that change with a note explaining the rationale. | ||
| - **Re-run locally.** Validate that `gitleaks detect --redact` reports no findings after the allowlist entry is added. | ||
| - **Reply on the PR.** Note that the finding is a false positive and link to the configuration change. | ||
|
|
||
| ## 4. Communicate | ||
| ## Need Help? | ||
|
|
||
| - Document the remediation steps in the pull request or issue, noting credential rotation status. | ||
| - For high-risk disclosures, email `[email protected]` to escalate privately. | ||
|
|
||
| ## 5. Verify and Prevent Recurrence | ||
|
|
||
| - Re-run the Gitleaks workflow (or trigger it manually) to confirm the repository is clean. | ||
| - Update the Gitleaks configuration in `.github/workflows/gitleaks.yml` to add new allowlist patterns, and only after validating they are false positives. | ||
| - Mention `@CivicTechWR/organizers` in the pull request comment if you need support rotating credentials or cleaning history. | ||
|
|
||
| ## Reference | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new config file is loaded automatically by
gitleaks detect --source ., and in Gitleaks a custom config does not include built-in rules unless[extend] useDefault = trueis set. Because this file only defines a global allowlist and no[[rules]]orextendblock, scans will effectively run with no detectors and can miss real secrets while still reporting success.Useful? React with 👍 / 👎.