Skip to main content

Travis CI

Prelude#

GitGuardian CI/CD integration with Travis CI 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.

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.
  3. In order to add gg-shield to your pipelines, configure your .travis.yml to add a gg-shield scanning job. For further explanation about how to define encrypted variables in Travis CI, please read their documentation.
jobs:  include:    - name: GitGuardian Scan      language: python      python: 3.8      install:        - pip install ggshield      script:        - ggshield scan ci