Skip to content

Commit

Permalink
docs(gitlab): add warning about MR pipelines
Browse files Browse the repository at this point in the history
  • Loading branch information
jguerreiro authored and Jguer committed Oct 29, 2021
1 parent 4af8e69 commit 428ea05
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 428ea05

Please sign in to comment.