Aller au contenu principal

CircleCI

Prélude​

L'intégration CI/CD de GitGuardian avec CircleCI s'effectue via notre application CLI : ggshield.
ggshield est un wrapper autour de l'API GitGuardian pour la détection de secrets, une clé API est requise pour l'authentification.

CircleCI est pris en charge dans ggshield via ggshield-orb.

Aperçu​

CircleCI output

Installation​

Les comptes de service sont recommandés pour exécuter cette intégration.

Veuillez noter que les comptes de service ne sont disponibles que pour les workspaces sous notre plan Growth ou Enterprise, et leur administration est réservée aux Managers. Si votre workspace est sous le plan Free, vous pouvez toujours utiliser un jeton d'accès personnel pour exécuter cette intégration.

  1. Créez un compte de service depuis la section API de votre workspace GitGuardian (ou un jeton d'accès personnel si vous êtes sur le plan Free).
  2. Ajoutez cette clé API à la variable d'environnement GITGUARDIAN_API_KEY dans les paramètres de votre projet.
  3. Afin d'ajouter ggshield à vos pipelines, configurez votre .circleci/config.yml en ajoutant l'orb ggshield :
orbs:
ggshield: gitguardian/ggshield

workflows:
main:
jobs:
- ggshield/scan:
name: ggshield-scan # best practice is to name each orb job
base_revision: << pipeline.git.base_revision >>
revision: <<pipeline.git.revision>>