Pre-push
Prélude
Un hook pre-push est un git hook côté client qui s'exécute juste avant qu'une référence ne soit poussée vers un dépôt distant (git push). Veuillez consulter notre centre d'apprentissage pour plus d'informations.
Le hook pre-push GitGuardian est exécuté via notre application CLI : ggshield. ggshield est un wrapper autour de l'API GitGuardian pour la détection de secrets qui nécessite une clé API pour fonctionner.
Aperçu

Personnalisez le message de remédiation et ajoutez le vôtre pour offrir aux développeurs des conseils précis afin de résoudre leurs problèmes de code et de poursuivre leur travail.
En savoir plus ici - Message de remédiation personnalisé de la CLI GitGuardian
Installation
Le framework pre-commit
Afin d'utiliser la CLI GitGuardian avec le framework pre-commit, vous devez effectuer les étapes suivantes.
- Assurez-vous d'avoir le framework pre-commit installé :
pip install pre-commit
- Créez un fichier
.pre-commit-config.yamlà la racine de votre dépôt :
repos:
- repo: https://github.com/gitguardian/ggshield
rev: v1.56.1
hooks:
- id: ggshield-push
language_version: python3
stages: [pre-push]
- Installez ensuite le hook avec la commande :
pre-commit install --hook-type pre-push
pre-commit installed at .git/hooks/pre-push
Vous êtes maintenant prêt !
Pour éviter de longs délais, par défaut le hook pre-push ne scannera pas les pushes comportant plus de 50 commits. Ce paramètre peut être configuré à l'aide de la clé
max-commits-for-hookdans le fichier de configuration de ggshield.
Hook pre-push global
Pour installer pre-push globalement (pour tous les dépôts actuels et futurs) :
- Connectez-vous à votre workspace GitGuardian et créez un Personal Access Token depuis vos paramètres personnels.
- Ajoutez ce Personal Access Token (clé API) à la variable d'environnement
GITGUARDIAN_API_KEYde votre environnement de développement. - Exécutez la commande suivante :
ggshield install --mode global -t pre-push
Elle va :
- vérifier si un dossier de hooks global est défini dans la configuration git globale.
- créer le dossier
~/.git/hooks(si nécessaire). - créer un fichier
pre-pushqui sera exécuté avant chaque commit. - donner les droits d'exécution à ce fichier.
Hook pre-push local
Vous pouvez installer le hook localement sur les dépôts souhaités :
- Connectez-vous à votre workspace GitGuardian et créez un Personal Access Token depuis vos paramètres personnels.
- Ajoutez ce Personal Access Token (clé API) à la variable d'environnement
GITGUARDIAN_API_KEYdans votre dépôt. - Allez dans le dépôt et exécutez la commande suivante :
ggshield install --mode local -t pre-push
Remarques :
- Si un fichier exécutable pre-push existe déjà, il ne sera pas écrasé. Vous pouvez forcer l'écrasement avec l'option
--force:
ggshield install --mode local -t pre-push --force