From 428ea056b1793188f956aa389adf5208690d40e9 Mon Sep 17 00:00:00 2001 From: jguerreiro Date: Fri, 29 Oct 2021 14:07:25 +0200 Subject: [PATCH] docs(gitlab): add warning about MR pipelines --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 04874b8a0d..63c092089e 100644 --- a/README.md +++ b/README.md @@ -736,10 +736,23 @@ stages: image: gitguardian/ggshield:latest stage: scanning script: ggshield scan ci + variables: + GIT_STRATEGY: clone + GIT_DEPTH: 0 ``` Do not forget to add your [GitGuardian API Key](https://dashboard.gitguardian.com/api/v1/auth/user/github_login/authorize?utm_source=github&utm_medium=gg_shield&utm_campaign=shield1) to the `GITGUARDIAN_API_KEY` environment variable in your project settings. +> For ggshield to scan every commit in a merge request pipeline the CI +> must clone the full repository instead of just fetching the branch. +> The following snippet ensures this behavior. + +```yml +variables: +GIT_STRATEGY: clone +GIT_DEPTH: 0 +``` + # GitHub > You may be interested in using GitGuardian's [GitHub integration](https://dashboard.gitguardian.com/settings/workspace/integrations/github) to ensure full coverage of your GitHub projects as well as full git history scans and reporting.