Bitbucket pipelines

Préambule

L'intégration CI/CD GitGuardian avec Bitbucket pipeline est exécutée 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.

⚠ Les pipelines Bitbucket ne prennent pas en charge les ranges de commits, donc seul votre dernier commit dans un groupe poussé ou dans une nouvelle branche sera scanné.

Aperçu

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 Business, et leur administration est limitée aux Managers. Si votre workspace est sous le plan Free, vous pouvez toujours utiliser un personal access token pour exécuter cette intégration.

1. Créez un compte de service depuis la section API de votre workspace GitGuardian (ou un personal access token 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. Ajoutez une nouvelle étape utilisant ggshield au pipeline de votre dépôt Bitbucket.

stages:
  - scanning

gitguardian scan:
  image: gitguardian/ggshield:latest
  stage: scanning
  script: ggshield secret scan ci

Vous pourriez être intéressé par l'utilisation de l'intégration Bitbucket de GitGuardian pour assurer une couverture complète de vos dépôts Bitbucket ainsi que des scans complets de l'historique git et des reportings.