Skip to content

Navigation Menu

Sign in
Sign up
This repository was archived by the owner on Jul 17, 2026. It is now read-only.

Add comprehensive TruffleHog security scanning documentation - #1255

Open
codegen-sh[bot] wants to merge 1 commit into
develop from
codegen-bot/add-trufflehog-security-docs-1758040754
Open

Add comprehensive TruffleHog security scanning documentation #1255
codegen-sh[bot] wants to merge 1 commit into
develop from
codegen-bot/add-trufflehog-security-docs-1758040754

Conversation

@codegen-sh

@codegen-sh codegen-sh Bot commented Sep 16, 2025

Copy link
Copy Markdown
Contributor

This PR adds comprehensive documentation for TruffleHog security scanning based on the implementation in the cloud repo.

What's Added

  • New documentation page: docs/sandboxes/security-scanning.mdx
  • Updated navigation: Added the new page to docs.json

Documentation Coverage

The new documentation explains:

Core Functionality

  • How TruffleHog integrates with Codegen's workflow
  • Pre-push hooks that scan modified files
  • Security scanning during signed commits

Configuration

  • .trufflehogignore file usage and patterns
  • Scan configuration options
  • Example ignore patterns for common false positives

Troubleshooting

  • How to handle scan failures
  • Resolving false positives vs real secrets
  • When and how to bypass scans (with strong warnings)

Best Practices

  • Secret management recommendations
  • Repository security guidelines
  • Team training considerations

Technical Details

  • Installation and command-line usage
  • Integration points in the codebase
  • Specific scan parameters used

Implementation Details from Cloud Repo

Based on analysis of the cloud repository, this documentation covers:

  • Pre-push hook implementation (scripts/pre-push.sh)
  • Signed commit tool integration (create_signed_commit)
  • Sandbox installation via Dockerfile
  • Real-world .trufflehogignore examples

The documentation provides users with everything they need to understand and work with TruffleHog security scanning in their Codegen workflows.


💻 View my work • 👤 Initiated by @kopekC • 💬 Initiated in #agi-testAbout Codegen
⛔ Remove Codegen from PR🚫 Ban action checks

- Add new security-scanning.mdx page explaining TruffleHog usage
- Document pre-push hooks and signed commit scanning
- Include configuration examples and troubleshooting guide
- Add best practices for secret management
- Update docs.json navigation to include new page
Co-authored-by: Eduardo Pujol <ed@codegen.com>

codecov Bot commented Sep 16, 2025
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@codegen-team codegen-team Awaiting requested review from codegen-team

At least 1 approving review is required to merge this pull request.

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /