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

update release version

Browse Source 
- update example releases
- add note regarding releases, since the examples was out-of-date

Signed-off-by: Thomas Sjögren <konstruktoid@users.noreply.github.com>
This commit is contained in:
Thomas Sjögren
2022-09-21 12:52:48 +02:00
parent ec3c0bce7e
commit eb86e593a5
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -67,6 +67,8 @@ It is as simple as running a CLI tool, making it easy to integrate into any proj
And official documentation page <a href="https://docs.kics.io">docs.kics.io</a> And official documentation page <a href="https://docs.kics.io">docs.kics.io</a>
And ensure that you're using the <a href="https://github.com/Checkmarx/kics-github-action/releases">latest KICS Github Action release</a> when creating a workflow.
## Inputs ## Inputs
| Variable | Example Value &nbsp; | Description &nbsp; | Type | Required | Default | | Variable | Example Value &nbsp; | Description &nbsp; | Type | Required | Default |
@ -109,7 +111,7 @@ And official documentation page <a href="https://docs.kics.io">docs.kics.io</a>
- 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-github-action@v1.3 uses: checkmarx/kics-github-action@v1.5
with: with:
# scanning two directories: ./terraform/ ./cfn-templates/ plus a single file # scanning two directories: ./terraform/ ./cfn-templates/ plus a single file
path: 'terraform,cfn-templates,my-other-sub-folder/Dockerfile' path: 'terraform,cfn-templates,my-other-sub-folder/Dockerfile'
@ -132,7 +134,7 @@ If you want KICS to ignore the results and return exit status code 0 unless a KI
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.3 uses: checkmarx/kics-github-action@v1.5
with: with:
path: 'terraform' path: 'terraform'
ignore_on_exit: results ignore_on_exit: results
@ -150,7 +152,7 @@ If want your pipeline just to fail on HIGH and MEDIUM severity results and KICS
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.3 uses: checkmarx/kics-github-action@v1.5
with: with:
path: 'terraform,my-other-sub-folder/Dockerfile' path: 'terraform,my-other-sub-folder/Dockerfile'
fail_on: high,medium fail_on: high,medium
@ -176,7 +178,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.3 uses: checkmarx/kics-github-action@v1.5
with: with:
path: test/samples/positive1.tf,test/samples/positive2.tf path: test/samples/positive1.tf,test/samples/positive2.tf
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
@ -235,7 +237,7 @@ You can only enable one profiler at a time, CPU or MEM.
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.3 uses: checkmarx/kics-github-action@v1.5
with: with:
path: 'terraform' path: 'terraform'
profiling: MEM profiling: MEM
@ -266,7 +268,7 @@ jobs:
# make sure results dir is created # make sure results dir is created
run: mkdir -p results-dir run: mkdir -p results-dir
- name: Run KICS Scan with SARIF result - name: Run KICS Scan with SARIF result
uses: checkmarx/kics-github-action@v1.3 uses: checkmarx/kics-github-action@v1.5
with: with:
path: 'terraform' path: 'terraform'
# when provided with a directory on output_path # when provided with a directory on output_path
@ -331,7 +333,7 @@ jobs:
} }
EOF EOF
- name: Run KICS Scan using config - name: Run KICS Scan using config
uses: checkmarx/kics-github-action@v1.2 uses: checkmarx/kics-github-action@v1.5
with: with:
path: 'terraform' path: 'terraform'
config_path: ./kics.config config_path: ./kics.config