HPCE/kics-github-action
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10 from Checkmarx/hotfix/documentation

Browse Source 
Fixing configuration docs link and yaml indentation
This commit is contained in:
Rogerio Peixoto
2021-03-22 09:19:15 +00:00
committed by GitHub
parent aaea9da303 42c7a670dd
commit cd7f978f59
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -44,15 +44,15 @@ It is as simple as running a CLI tool, making it easy to integrate into any proj
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2 - uses: actions/checkout@v2
# Scan Iac with kics # Scan Iac with kics
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-action@v1.0 uses: checkmarx/kics-action@v1.0
with: with:
path: 'terraform' path: 'terraform'
output_path: 'results.json' output_path: 'results.json'
# Display the results in json format # Display the results in json format
- name: display kics results - name: display kics results
run: | run: |
cat results.json cat results.json
``` ```
## Example using docker-runner and SARIF report ## Example using docker-runner and SARIF report
@@ -84,7 +84,7 @@ jobs:
# it will generate the specified reports file named 'results.{extension}' # it will generate the specified reports file named 'results.{extension}'
# in this example it will generate: # in this example it will generate:
# - results-dir/results.json # - results-dir/results.json
# - results-dir/results.json # - results-dir/results.sarif
output_path: results-dir output_path: results-dir
platform_type: terraform platform_type: terraform
output_formats: 'json,sarif' output_formats: 'json,sarif'
@@ -102,7 +102,7 @@ jobs:
``` ```
## Example using docker-runner and a config file ## Example using docker-runner and a config file
Check [configuration file](./configuration-file.md) reference for more options. Check [configuration file](https://github.com/Checkmarx/kics/blob/master/docs/configuration-file.md) reference for more options.
```yaml ```yaml
name: scan with KICS using config file name: scan with KICS using config file