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

additional fixes

Browse Source
This commit is contained in:
Rogério Peixoto
2021-03-18 15:42:13 +00:00
parent 1bd03f632b
commit b1e842aded
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -36,7 +36,7 @@ It is as simple as running a CLI tool, making it easy to integrate into any proj
| queries | | path to directory with queries (default "./assets/queries") | String | No | ./assets/queries downloaded with the binaries | | queries | | path to directory with queries (default "./assets/queries") | String | No | ./assets/queries downloaded with the binaries |
| verbose | true | verbose scan | Boolean | No | false | | verbose | true | verbose scan | Boolean | No | false |
## Simple Example usage ## Simple usage example
```yaml ```yaml
# 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
@ -55,7 +55,7 @@ It is as simple as running a CLI tool, making it easy to integrate into any proj
cat results.json cat results.json
``` ```
## Example Using Docker Runner and SARIF report ## Example using docker-runner and 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` 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`
@ -100,7 +100,9 @@ jobs:
with: with:
sarif_file: results-dir/results.sarif sarif_file: results-dir/results.sarif
``` ```
## Example using docker-runner and config file ## Example using docker-runner and a config file
Check [configuration file](./configuration-file.md) reference for more options.
```yaml ```yaml
name: scan with KICS using config file name: scan with KICS using config file
@ -120,6 +122,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: Create config file - name: Create config file
# creating a heredoc config file
run: | run: |
cat <<EOF >>kics.config cat <<EOF >>kics.config
{ {
@ -130,7 +133,6 @@ jobs:
"no-color": false, "no-color": false,
"no-progress": true, "no-progress": true,
"output-path": "./results-dir", "output-path": "./results-dir",
"path": "terraform,ansible",
"payload-path": "file path to store source internal representation in JSON format", "payload-path": "file path to store source internal representation in JSON format",
"preview-lines": 5, "preview-lines": 5,
"report-formats": "json,sarif", "report-formats": "json,sarif",