diff --git a/docs/getting-started/continuous_integration.md b/docs/getting-started/continuous_integration.md index f80232cc5..51c71a05a 100644 --- a/docs/getting-started/continuous_integration.md +++ b/docs/getting-started/continuous_integration.md @@ -48,9 +48,9 @@ fuzzing more effective and gives you regression testing for free. You can integrate CIFuzz into your project using the following steps: 1. Create a `.github` directory in the root of your project. 1. Create a `workflows` directory inside of your `.github` directory. -1. Copy the example [`main.yml`](https://github.com/google/oss-fuzz/blob/master/infra/cifuzz/example_main.yml) +1. Copy the example [`cifuzz.yml`](https://github.com/google/oss-fuzz/blob/master/infra/cifuzz/example_cifuzz.yml) file over from the OSS-Fuzz repository to the `workflows` directory. -1. Change the `oss-fuzz-project-name` value in `main.yml` from `example` to the name of your OSS-Fuzz project. It is **very important** that you use your OSS-Fuzz project name which is case sensitive. This name +1. Change the `oss-fuzz-project-name` value in `cifuzz.yml` from `example` to the name of your OSS-Fuzz project. It is **very important** that you use your OSS-Fuzz project name which is case sensitive. This name is the name of your project's subdirectory in the [`projects`](https://github.com/google/oss-fuzz/tree/master/projects) directory of OSS-Fuzz. 1. Set the value of `fuzz-seconds`. The longest time that the project maintainers are acceptable with should be used. This value should be at minimum 600 seconds and scale with project size. @@ -59,11 +59,11 @@ Your directory structure should look like the following: project |___ .github | |____ workflows -| |____ main.yml +| |____ cifuzz.yml |___ other-files ``` -main.yml for an example project: +cifuzz.yml for an example project: ```yaml name: CIFuzz @@ -85,7 +85,7 @@ jobs: language: c++ fuzz-seconds: 600 - name: Upload Crash - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v3 if: failure() && steps.build.outcome == 'success' with: name: artifacts @@ -195,7 +195,7 @@ jobs: language: c++ fuzz-seconds: 600 - name: Upload Crash - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v3 if: failure() && steps.build.outcome == 'success' with: name: artifacts diff --git a/infra/cifuzz/example_main.yml b/infra/cifuzz/example_cifuzz.yml similarity index 87% rename from infra/cifuzz/example_main.yml rename to infra/cifuzz/example_cifuzz.yml index 82c239ca6..5f31b381c 100644 --- a/infra/cifuzz/example_main.yml +++ b/infra/cifuzz/example_cifuzz.yml @@ -9,15 +9,13 @@ jobs: uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master with: oss-fuzz-project-name: 'example' - dry-run: false - name: Run Fuzzers uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master with: oss-fuzz-project-name: 'example' fuzz-seconds: 600 - dry-run: false - name: Upload Crash - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v3 if: failure() && steps.build.outcome == 'success' with: name: artifacts