> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# gitguardian/ggshield

Easily integrate GitGuardian shield into your CircleCI projects. Scan your commits for secrets and other policy breaks


## Jobs

### scan

| Parameter | Type | Default | Description |
|---|---|---|---|
| `base_revision` | string |  | ID of the first commit to scan. Leave empty to only scan the latest
commit.
 |
| `revision` | string |  | ID of the last commit to scan. |
| `tag` | string | latest | Pick a specific gitguardian/ggshield image variant:
https://hub.docker.com/r/gitguardian/ggshield/tags
 |

## Examples

### scan

Scan commits when they land on VCS. Do not forget to add an environment
variable GITGUARDIAN_API_KEY with your API Key in the project settings


```yaml
version: 2.1
orbs:
  ggshield: gitguardian/ggshield@x.y
workflows:
  scan_my_commits:
    jobs:
      - ggshield/scan:
          name: ggshield-scan
          base_revision: <<pipeline.git.base_revision>>
          revision: <<pipeline.git.revision>>
```