GitGuardian Shield CircleCI Orb scans commits to detect exposed credentials and potential security vulnerabilities automatically in CI pipelines.
GitGuardian Shield Circle CI Orb - Find exposed credentials in your commits
This tool is designed for developers and DevOps teams who want to automate the detection of secrets and sensitive information in their code commits during continuous integration workflows. It integrates with CircleCI to scan commits for over 200 types of secrets and policy violations, helping prevent accidental exposure of credentials before code is merged or deployed.
An API key from GitGuardian is required to use this tool. The scanning is stateless and does not store any scanned files or detected secrets, ensuring privacy. Best practice includes naming each orb job distinctly in CircleCI workflows for clarity.
Configure your .circleci/config.yml to add the ggshield orb
Add the following to your config.yml under orbs: ggshield: gitguardian/ggshield@volatile
Define a workflow and add the ggshield/scan job with base_revision and revision parameters
Set the GITGUARDIAN_API_KEY environment variable in your project settings with your GitGuardian API keyggshield/scan
Orb job to scan commits between base_revision and revision for exposed secrets