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

feat(v1.2): support kics 1.3.0 using docker-runner as default

Browse Source 
Signed-off-by: Rogério Peixoto <rogerio.peixoto@checkmarx.com>
This commit is contained in:
Rogério Peixoto
2021-05-10 18:50:02 +01:00
parent b0ad16a043
commit c510bce1ac
2 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Dockerfile
View File

@ -4,4 +4,4 @@ COPY entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh RUN chmod +x /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"] ENTRYPOINT ["/entrypoint.sh"]

11
README.md
View File

@ -130,12 +130,11 @@ You can only enable one profiler at a time, CPU or MEM.
cat results.json cat results.json
``` ```
## Example using docker-runner and SARIF report ## Uploading SARIF report
checkmarx/kics-action@docker-runner branch runs an alpine based linux container (`checkmarx/kics:nightly-alpine`) that doesn't require downloading kics binaries and queries in the `entrypoint.sh`
```yaml ```yaml
name: scan with KICS docker-runner name: scan with KICS and upload SARIF
on: on:
pull_request: pull_request:
@ -152,7 +151,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-action@docker-runner uses: checkmarx/kics-action@v1.2
with: with:
path: 'terraform' path: 'terraform'
# when provided with a directory on output_path # when provided with a directory on output_path
@ -176,7 +175,7 @@ jobs:
sarif_file: results-dir/results.sarif sarif_file: results-dir/results.sarif
``` ```
## Example using docker-runner and a config file ## Using configuration file
Check [configuration file](https://github.com/Checkmarx/kics/blob/master/docs/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.
@ -217,7 +216,7 @@ jobs:
} }
EOF EOF
- name: Run KICS Scan using config - name: Run KICS Scan using config
uses: checkmarx/kics-action@docker-runner uses: checkmarx/kics-action@v1.2
with: with:
path: 'terraform' path: 'terraform'
config_path: ./kics.config config_path: ./kics.config