Skip to main content

GitLab pipelines

Prelude#

GitGuardian CI/CD integration with GitLab pipeline is performed through our CLI application gg-shield. gg-shield is a wrapper around GitGuardian API for secrets detection that requires an API key to work.

Preview#

GitLab pipelines status

GitLab pipelines output

Installation#

  1. Create an API key within the API section of your GitGuardian workspace.
  2. Add this API key to the GITGUARDIAN_API_KEY environment variable in your project settings.

GitLab pipelines env

  1. Add a new step using gg-shield to your GitLab project's pipeline.
stages:  - scanning
🦉 gitguardian scan:  image: gitguardian/ggshield:latest  stage: scanning  script: ggshield scan ci

You may be interested in using GitGuardian's GitLab integration to ensure full coverage of your GitLab projects as well as full git history scans and reporting.