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

Merge pull request #70 from cdivitotawela/doc-updates

Browse Source 
README updates
This commit is contained in:
Gabriel
2022-11-02 15:49:50 +00:00
committed by GitHub
parent c2ef4b7d4a d237b765c1
commit 40fa83aa10
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -110,10 +110,10 @@ And ensure that you're using the <a href="https://github.com/Checkmarx/kics-gith
# Steps represent a sequence of tasks that will be executed as part of the job # Steps represent a sequence of tasks that will be executed as part of the job
steps: steps:
# 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@v3
# Scan Iac with kics # Scan Iac with kics
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.5 uses: checkmarx/kics-github-action@v1.6
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'
@ -134,9 +134,9 @@ If you want KICS to ignore the results and return exit status code 0 unless a KI
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.5 uses: checkmarx/kics-github-action@v1.6
with: with:
path: 'terraform' path: 'terraform'
ignore_on_exit: results ignore_on_exit: results
@ -152,9 +152,9 @@ If want your pipeline just to fail on HIGH and MEDIUM severity results and KICS
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.5 uses: checkmarx/kics-github-action@v1.6
with: with:
path: 'terraform,my-other-sub-folder/Dockerfile' path: 'terraform,my-other-sub-folder/Dockerfile'
fail_on: high,medium fail_on: high,medium
@ -178,9 +178,9 @@ jobs:
test: test:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.5 uses: checkmarx/kics-github-action@v1.6
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 }}
@ -237,9 +237,9 @@ You can only enable one profiler at a time, CPU or MEM.
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: run kics Scan - name: run kics Scan
uses: checkmarx/kics-github-action@v1.5 uses: checkmarx/kics-github-action@v1.6
with: with:
path: 'terraform' path: 'terraform'
profiling: MEM profiling: MEM
@ -265,12 +265,12 @@ jobs:
name: kics-action name: kics-action
steps: steps:
- name: Checkout repo - name: Checkout repo
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Mkdir results-dir - name: Mkdir results-dir
# 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.5 uses: checkmarx/kics-github-action@v1.6
with: with:
path: 'terraform' path: 'terraform'
# when provided with a directory on output_path # when provided with a directory on output_path
@ -311,7 +311,7 @@ jobs:
name: kics-action name: kics-action
steps: steps:
- name: Checkout repo - name: Checkout repo
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Mkdir results-dir - name: Mkdir results-dir
# make sure results dir is created # make sure results dir is created
run: mkdir -p results-dir run: mkdir -p results-dir
@ -335,7 +335,7 @@ jobs:
} }
EOF EOF
- name: Run KICS Scan using config - name: Run KICS Scan using config
uses: checkmarx/kics-github-action@v1.5 uses: checkmarx/kics-github-action@v1.6
with: with:
path: 'terraform' path: 'terraform'
config_path: ./kics.config config_path: ./kics.config