Skip to content

Commit 203a614

Browse files
authored
Fix README examples
1 parent 4a2320c commit 203a614

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Sourcehawk Scan Github Action
2-
-----------------------------
1+
# Sourcehawk Scan Github Action
32

43
![Latest Version](https://img.shields.io/github/v/tag/optum/sourcehawk-scan-github-action?label=version&sort=semver)
54
[![Build Status](https://github.com/optum/sourcehawk-scan-github-action/workflows/CI/badge.svg)](https://github.com/optum/sourcehawk-scan-github-action/actions)
@@ -63,21 +62,32 @@ The below example accepts all the defaults
6362
uses: optum/sourcehawk-scan-github-action@v1
6463
```
6564
65+
### Fail if Warnings Found
66+
Scan will be considered a failure, if warnings are found
67+
68+
```yaml
69+
uses: optum/sourcehawk-scan-github-action@v1
70+
with:
71+
fail-on-warnings: true
72+
```
73+
6674
### Custom Configuration File
6775
Provide the location to a configuration file in a custom path
6876
6977
```yaml
7078
uses: optum/sourcehawk-scan-github-action@v1
71-
config-file: .sourcehawk/config.yml
79+
with:
80+
config-file: .sourcehawk/config.yml
7281
```
7382
7483
### JSON Output Format
7584
Output the scan results in `JSON` format
7685

7786
```yaml
7887
uses: optum/sourcehawk-scan-github-action@v1
79-
output-format: JSON
80-
output-file: sourcehawk-scan-results.json
88+
with:
89+
output-format: JSON
90+
output-file: sourcehawk-scan-results.json
8191
```
8292

8393
## Example Workflow

0 commit comments

Comments
 (0)