Skip to content

Conversation

@codegen-sh
Copy link
Contributor

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

This PR adds comprehensive documentation for Codegen's Trufflehog integration to help users understand how secret scanning works and how to configure it properly.

What's Added

  • New documentation article: docs/settings/trufflehog-integration.mdx
  • Navigation update: Added the new article to the Settings section in docs.json

Content Overview

The documentation covers:

How It Works

  • Pre-push hook scanning that blocks pushes containing potential secrets
  • Agent commit scanning during signed commit creation
  • Integration points in the development workflow

Configuration

  • .trufflehogignore file patterns and syntax
  • Scanning scope covering API keys, database credentials, private keys, and tokens
  • Examples of common ignore patterns

Working with Detections

  • How to handle blocked pushes
  • Agent error handling and bypass options
  • Resolution workflows for both false positives and real secrets

Best Practices

  • Repository setup recommendations
  • Secret management guidelines
  • Team workflow considerations

Troubleshooting

  • Common issues and solutions
  • Performance considerations
  • Support resources

Style & Format

The article follows the established documentation conventions:

  • Uses the same MDX format as other docs
  • Includes appropriate Mintlify components (Card, Warning, Note)
  • Follows the tone and structure of existing articles like sandboxes/overview.mdx
  • Avoids being a "listicle" or "AI slop" as requested

Fixes CG-19610


💻 View my work • 👤 Initiated by @jayhackAbout Codegen
⛔ Remove Codegen from PR🚫 Ban action checks

- Add comprehensive docs on Trufflehog integration in settings section
- Cover pre-push hook scanning and agent commit scanning
- Include configuration, best practices, and troubleshooting
- Update docs.json navigation to include new article

Co-authored-by: Jay Hack <jay@codegen.sh>
@codecov
Copy link

codecov bot commented Sep 16, 2025

Codecov Report

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

icon: "shield-check"
---

Codegen integrates Trufflehog, an open-source secret scanning tool, to automatically detect and prevent sensitive information from being committed to your repositories. This security layer protects against accidental exposure of API keys, passwords, tokens, and other secrets.
Copy link
Contributor

Choose a reason for hiding this comment

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

Link to it on Github

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it! I'll check the Github link and review the comments... 🔍

💻 View my work🛑 Stop

Copy link
Contributor Author

Choose a reason for hiding this comment

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

✅ Done! I've added a link to Trufflehog's GitHub repository in the documentation. The change has been pushed to the existing PR.

🔄 View Updated PR #1254 on Github 🔄

💻 View my work🛑 Stop

Co-authored-by: Jay Hack <jay@codegen.sh>
@jayhack jayhack merged commit 35c841e into develop Sep 16, 2025
19 checks passed
@jayhack jayhack deleted the codegen-bot/add-trufflehog-docs-1758039226 branch September 16, 2025 17:26
@github-actions
Copy link
Contributor

🎉 This PR is included in version 0.56.22 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants