Aller au contenu principal

Jenkins CI

Prélude​

L'intégration CI/CD de GitGuardian avec Jenkins CI est réalisé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.

Aperçu​

Jenkins CI status

Jenkins CI output

Installation​

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

Veuillez noter que les comptes de service sont uniquement disponibles pour les workspaces bénéficiant de 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 token 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 token d'accès personnel si vous êtes sous le plan Free).
  2. Ajoutez cette clé API à la variable d'environnement GITGUARDIAN_API_KEY dans les paramètres de votre projet.

Bitbucket pipelines env

  1. Afin d'ajouter ggshield à vos pipelines, configurez votre Jenkinsfile pour ajouter une étape ggshield :
pipeline {
agent none
stages {
stage('GitGuardian Scan') {
agent {
docker { image 'gitguardian/ggshield:latest' }
}
environment {
GITGUARDIAN_API_KEY = credentials('gitguardian-api-key')
}
steps {
sh 'ggshield secret scan ci'
}
}
}
}