Skip to content

Commit

Permalink
document show only failed test flag
Browse files Browse the repository at this point in the history
  • Loading branch information
makoscafee committed Feb 24, 2021
1 parent 0aa1737 commit 8bbe13b
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/infrastructure-as-code.md
Expand Up @@ -21,12 +21,21 @@ polaris version
```

## Running in a CI pipeline
You can tell the CLI to set an exit code if it detects certain issues with your
YAML files.

### Set minimum score for an exit code
You can tell the CLI to set an exit code if it detects certain issues with your YAML files.
For example, to fail if polaris detects *any* danger-level issues, or if the score drops below 90%:
```bash
polaris audit --audit-path ./deploy/ \
--set-exit-code-on-danger \
--set-exit-code-below-score 90
```

### Output only showing failed tests
The CLI to gives you ability to display results containing only failed tests.
For example:
```bash
polaris audit --audit-path ./deploy/ \
--only-show-failed-tests true
```

0 comments on commit 8bbe13b

Please sign in to comment.