Skip to content

Commit 80105a7

Browse files
Remind people to change the language (#109)
1 parent 037e1ee commit 80105a7

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/running-clusterfuzzlite/github_actions.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ jobs:
7272
id: build
7373
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
7474
with:
75-
language: c++
75+
language: c++ # Change this to the language you are fuzzing.
7676
github-token: ${{ secrets.GITHUB_TOKEN }}
7777
sanitizer: ${{ matrix.sanitizer }}
7878
# Optional but recommended: used to only run fuzzers that are affected
@@ -99,6 +99,7 @@ jobs:
9999
{% endraw %}
100100

101101
Optionally, edit the following fields to customize your settings:
102+
- `language` Change to the language of your target code.
102103
- `sanitizers` Change or enable more sanitizers.
103104
- `fuzz-seconds` Change the amount of time spent fuzzing.
104105
- `storage-repo`, `storage-repo-branch`,
@@ -144,7 +145,7 @@ jobs:
144145
id: build
145146
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
146147
with:
147-
language: c++
148+
language: c++ # Change this to the language you are fuzzing.
148149
sanitizer: ${{ matrix.sanitizer }}
149150
- name: Run Fuzzers (${{ matrix.sanitizer }})
150151
id: run
@@ -163,6 +164,7 @@ jobs:
163164
{% endraw %}
164165

165166
Optionally, edit the following fields to customize your settings:
167+
- `language` Change to the language of your target code.
166168
- `cron` Change how frequently batch fuzzing is run. See [GitHub's documentation] on this.
167169
- `sanitizers` Change or enable more sanitizers.
168170
- `fuzz-seconds` Change the amount of time spent fuzzing.
@@ -228,7 +230,7 @@ jobs:
228230
id: build
229231
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
230232
with:
231-
language: c++
233+
language: c++ # Change this to the language you are fuzzing.
232234
sanitizer: ${{ matrix.sanitizer }}
233235
upload-build: true
234236
```
@@ -259,7 +261,7 @@ jobs:
259261
id: build
260262
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
261263
with:
262-
language: c++
264+
language: c++ # Change this to the language you are fuzzing
263265
- name: Run Fuzzers
264266
id: run
265267
uses: google/clusterfuzzlite/actions/run_fuzzers@v1
@@ -276,7 +278,7 @@ jobs:
276278
{% endraw %}
277279

278280
Optionally, edit the following field to customize your settings:
279-
281+
- `language` Change to the language of your target code.
280282
- `storage-repo`, `storage-repo-branch`,
281283
`storage-repo-branch-coverage` Enable a [storage repo].
282284

@@ -295,7 +297,7 @@ jobs:
295297
id: build
296298
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
297299
with:
298-
language: c++
300+
language: c++ # Change this to the language you are fuzzing.
299301
sanitizer: coverage
300302
- name: Run Fuzzers
301303
id: run
@@ -313,6 +315,7 @@ jobs:
313315
```
314316
{% endraw %}
315317

318+
Make sure to change to the `language` to that of your target code.
316319
Optionally, edit the following fields to view coverage reports at
317320
`https://USERNAME.github.io/STORAGE-REPO-NAME/coverage/latest/report/linux/report.html`:
318321
- set `storage-repo` ([instructions here])

0 commit comments

Comments
 (0)