Skip to content

Remind people to change the language #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2022
Merged

Remind people to change the language #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/running-clusterfuzzlite/github_actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ jobs:
id: build
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
with:
language: c++
language: c++ # Change this to the language you are fuzzing.
github-token: ${{ secrets.GITHUB_TOKEN }}
sanitizer: ${{ matrix.sanitizer }}
# Optional but recommended: used to only run fuzzers that are affected
Expand All @@ -99,6 +99,7 @@ jobs:
{% endraw %}

Optionally, edit the following fields to customize your settings:
- `language` Change to the language of your target code.
- `sanitizers` Change or enable more sanitizers.
- `fuzz-seconds` Change the amount of time spent fuzzing.
- `storage-repo`, `storage-repo-branch`,
Expand Down Expand Up @@ -144,7 +145,7 @@ jobs:
id: build
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
with:
language: c++
language: c++ # Change this to the language you are fuzzing.
sanitizer: ${{ matrix.sanitizer }}
- name: Run Fuzzers (${{ matrix.sanitizer }})
id: run
Expand All @@ -163,6 +164,7 @@ jobs:
{% endraw %}

Optionally, edit the following fields to customize your settings:
- `language` Change to the language of your target code.
- `cron` Change how frequently batch fuzzing is run. See [GitHub's documentation] on this.
- `sanitizers` Change or enable more sanitizers.
- `fuzz-seconds` Change the amount of time spent fuzzing.
Expand Down Expand Up @@ -228,7 +230,7 @@ jobs:
id: build
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
with:
language: c++
language: c++ # Change this to the language you are fuzzing.
sanitizer: ${{ matrix.sanitizer }}
upload-build: true
```
Expand Down Expand Up @@ -259,7 +261,7 @@ jobs:
id: build
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
with:
language: c++
language: c++ # Change this to the language you are fuzzing
- name: Run Fuzzers
id: run
uses: google/clusterfuzzlite/actions/run_fuzzers@v1
Expand All @@ -276,7 +278,7 @@ jobs:
{% endraw %}

Optionally, edit the following field to customize your settings:

- `language` Change to the language of your target code.
- `storage-repo`, `storage-repo-branch`,
`storage-repo-branch-coverage` Enable a [storage repo].

Expand All @@ -295,7 +297,7 @@ jobs:
id: build
uses: google/clusterfuzzlite/actions/build_fuzzers@v1
with:
language: c++
language: c++ # Change this to the language you are fuzzing.
sanitizer: coverage
- name: Run Fuzzers
id: run
Expand All @@ -313,6 +315,7 @@ jobs:
```
{% endraw %}

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