Skip to content

gitlab: improve documentation #106

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 22, 2022
Merged

gitlab: improve documentation #106

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
11 changes: 7 additions & 4 deletions docs/running-clusterfuzzlite/gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ To enable more features, we recommend having different jobs for:
To add a fuzzing job that fuzzes all merge requests to your repo, add the
following default configurations to `.gitlab-ci.yml`:

This configuration requires at least GitLab 13.3 to be run.
With older versions, the `parallel` keywords does not exist, but you can define `SANITIZER` as a Gitlab CI variable.

{% raw %}
```yaml
variables:
Expand All @@ -48,7 +51,7 @@ clusterfuzzlite:
image:
name: gcr.io/oss-fuzz-base/clusterfuzzlite-run-fuzzers:v1
entrypoint: [""]
stage: fuzz
stage: test
parallel:
matrix:
- SANITIZER: [address, undefined]
Expand Down Expand Up @@ -96,7 +99,7 @@ clusterfuzzlite-corpus:
image:
name: gcr.io/oss-fuzz-base/clusterfuzzlite-run-fuzzers:v1
entrypoint: [""]
stage: fuzz
stage: test
Copy link
Collaborator

@jonathanmetzman jonathanmetzman Aug 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change?

Copy link
Contributor Author

@catenacyber catenacyber Aug 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cf default pipeline stages in https://docs.gitlab.com/ee/ci/yaml/#stages

To keep stage: fuzz,
you need to add stages: - fuzz somewhere (with an s)

rules:
- if: $MODE == "prune"
- if: $MODE == "batch"
Expand Down Expand Up @@ -136,7 +139,7 @@ clusterfuzzlite-build:
image:
name: gcr.io/oss-fuzz-base/clusterfuzzlite-run-fuzzers:v1
entrypoint: [""]
stage: fuzz
stage: test
rules:
# Use $CI_DEFAULT_BRANCH or $CFL_BRANCH.
- if: $CI_COMMIT_BRANCH == $CFL_BRANCH && $CI_PIPELINE_SOURCE == "push"
Expand Down Expand Up @@ -165,7 +168,7 @@ clusterfuzzlite-coverage:
image:
name: gcr.io/oss-fuzz-base/clusterfuzzlite-run-fuzzers:v1
entrypoint: [""]
stage: fuzz
stage: test
variables:
SANITIZER: "coverage"
rules:
Expand Down