Skip to content

Commit d237b76

Browse files
committed
README updates
Examples in README.md has been updated to use checkout v3 and kics latest version 1.6. These will help users to copy and use the example with latest versions.
1 parent c2ef4b7 commit d237b76

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ And ensure that you're using the <a href="https://github.com/Checkmarx/kics-gith
110110
# Steps represent a sequence of tasks that will be executed as part of the job
111111
steps:
112112
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
113-
- uses: actions/checkout@v2
113+
- uses: actions/checkout@v3
114114
# Scan Iac with kics
115115
- name: run kics Scan
116-
uses: checkmarx/kics-github-action@v1.5
116+
uses: checkmarx/kics-github-action@v1.6
117117
with:
118118
# scanning two directories: ./terraform/ ./cfn-templates/ plus a single file
119119
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
134134
135135
```yaml
136136
steps:
137-
- uses: actions/checkout@v2
137+
- uses: actions/checkout@v3
138138
- name: run kics Scan
139-
uses: checkmarx/kics-github-action@v1.5
139+
uses: checkmarx/kics-github-action@v1.6
140140
with:
141141
path: 'terraform'
142142
ignore_on_exit: results
@@ -152,9 +152,9 @@ If want your pipeline just to fail on HIGH and MEDIUM severity results and KICS
152152
153153
```yaml
154154
steps:
155-
- uses: actions/checkout@v2
155+
- uses: actions/checkout@v3
156156
- name: run kics Scan
157-
uses: checkmarx/kics-github-action@v1.5
157+
uses: checkmarx/kics-github-action@v1.6
158158
with:
159159
path: 'terraform,my-other-sub-folder/Dockerfile'
160160
fail_on: high,medium
@@ -178,9 +178,9 @@ jobs:
178178
test:
179179
runs-on: ubuntu-latest
180180
steps:
181-
- uses: actions/checkout@v2
181+
- uses: actions/checkout@v3
182182
- name: run kics Scan
183-
uses: checkmarx/kics-github-action@v1.5
183+
uses: checkmarx/kics-github-action@v1.6
184184
with:
185185
path: test/samples/positive1.tf,test/samples/positive2.tf
186186
token: ${{ secrets.GITHUB_TOKEN }}
@@ -237,9 +237,9 @@ You can only enable one profiler at a time, CPU or MEM.
237237

238238
```yaml
239239
steps:
240-
- uses: actions/checkout@v2
240+
- uses: actions/checkout@v3
241241
- name: run kics Scan
242-
uses: checkmarx/kics-github-action@v1.5
242+
uses: checkmarx/kics-github-action@v1.6
243243
with:
244244
path: 'terraform'
245245
profiling: MEM
@@ -265,12 +265,12 @@ jobs:
265265
name: kics-action
266266
steps:
267267
- name: Checkout repo
268-
uses: actions/checkout@v2
268+
uses: actions/checkout@v3
269269
- name: Mkdir results-dir
270270
# make sure results dir is created
271271
run: mkdir -p results-dir
272272
- name: Run KICS Scan with SARIF result
273-
uses: checkmarx/kics-github-action@v1.5
273+
uses: checkmarx/kics-github-action@v1.6
274274
with:
275275
path: 'terraform'
276276
# when provided with a directory on output_path
@@ -311,7 +311,7 @@ jobs:
311311
name: kics-action
312312
steps:
313313
- name: Checkout repo
314-
uses: actions/checkout@v2
314+
uses: actions/checkout@v3
315315
- name: Mkdir results-dir
316316
# make sure results dir is created
317317
run: mkdir -p results-dir
@@ -335,7 +335,7 @@ jobs:
335335
}
336336
EOF
337337
- name: Run KICS Scan using config
338-
uses: checkmarx/kics-github-action@v1.5
338+
uses: checkmarx/kics-github-action@v1.6
339339
with:
340340
path: 'terraform'
341341
config_path: ./kics.config

0 commit comments

Comments
 (0)