Azure pipelines

Préambule

L'intégration CI/CD GitGuardian avec Azure Pipelines 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.

⚠ Azure Pipelines ne prend pas en charge les ranges de commits en dehors des Pull Requests GitHub, donc lors d'événements push sur une branche normale, seul votre dernier commit sera scanné. Cette limitation ne s'applique pas aux Pull Requests GitHub où tous les commits de la pull request seront scannés.

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 secrète gitguardianApiKey dans les paramètres de votre pipeline.

   • Comment définir des variables secrètes dans Azure Pipelines

3. Ajoutez un nouveau job utilisant ggshield à votre pipeline Azure

jobs:
  - job: GitGuardianShield
    pool:
      vmImage: 'ubuntu-latest'
    container: gitguardian/ggshield:latest
    steps:
      - script: ggshield secret scan ci
        env:
          GITGUARDIAN_API_KEY: $(gitguardianApiKey)