Add minimal README about the ClusterFuzzLite

Signed-off-by: Jakub Sztandera <[email protected]>

Author: Kubuxu

.github/workflows/README.md

@@ -0,0 +1,13 @@
+### Fuzzing setup
+
+ref-fvm uses [ClusterFuzzLite](https://google.github.io/clusterfuzzlite/) for contious fuzzing.
+This consists of four workflows:
+  - `cflite_pr.yml` - responsible for running fuzzing for PRs, it will only fuzz targets when diff affects files covered by given fuzzing target
+  - `cflite_build.yml` - responsible for building fuzzing targets on master branch and storing them for recall. These recalled targets are used to detect if crasher is a new thing caused by changes or a newely discovered input which will also cause crash on master.
+  - `cflite_batch.yml` - periodically (every 6h for 1h) runs fuzzing to develop the corpus which will be used for other on-demand fuzzing and as seed corpus for OSS-Fuzz.
+  - `cflite_cron.yml` - every day generates coverage reports, as well as, prunes and mimizes the corpus.
+
+
+Corpus and coverage data is stored within https://github.com/filecoin-project/ref-fvm-fuzz-corpora 
+
+

.github/workflows/cflite_batch.yml

@@ -1,7 +1,7 @@
 name: ClusterFuzzLite batch fuzzing
 on:
   schedule:
-    - cron: '0 0/12 * * *'  # Every 12th hour. Change this to whatever is suitable.
+    - cron: '0 0/6 * * *'  # Every 6th hour. Change this to whatever is suitable.
 permissions: read-all
 jobs:
   BatchFuzzing:
@@ -10,7 +10,7 @@ jobs:
       fail-fast: false
       matrix:
         sanitizer:
-        - address
+          - address
     steps:
     - name: Build Fuzzers (${{ matrix.sanitizer }})
       id: build
@@ -28,6 +28,6 @@ jobs:
         # Optional but recommended: For storing certain artifacts from fuzzing.
         # See later section on "Git repo for storage".
         storage-repo: https://${{ secrets.FILHELPER_PAT }}@github.com/filecoin-project/ref-fvm-fuzz-corpora.git
-        storage-repo-branch: lite
+        storage-repo-branch: master
         storage-repo-branch-coverage: gh-pages  # Optional. Defaults to "gh-pages".
 

.github/workflows/cflite_cron.yml

@@ -1,7 +1,7 @@
 name: ClusterFuzzLite cron tasks
 on:
   schedule:
-    - cron: '0 0 * * *'  # Once a day at midnight.
+    - cron: '30 1 * * *'  # Once a day at 1:30 to run past batch job
 permissions: read-all
 jobs:
   Pruning:
@@ -18,7 +18,7 @@ jobs:
         fuzz-seconds: 600
         mode: 'prune'
         storage-repo: https://${{ secrets.FILHELPER_PAT }}@github.com/filecoin-project/ref-fvm-fuzz-corpora.git
-        storage-repo-branch: lite
+        storage-repo-branch: master
         storage-repo-branch-coverage: gh-pages  # Optional. Defaults to "gh-pages".
   Coverage:
     runs-on: ubuntu-latest
@@ -37,6 +37,6 @@ jobs:
         mode: 'coverage'
         sanitizer: 'coverage'
         storage-repo: https://${{ secrets.FILHELPER_PAT }}@github.com/filecoin-project/ref-fvm-fuzz-corpora.git
-        storage-repo-branch: lite
+        storage-repo-branch: master
         storage-repo-branch-coverage: gh-pages  # Optional. Defaults to "gh-pages".
 

.github/workflows/cflite_pr.yml

@@ -29,7 +29,7 @@ jobs:
         # by the PR.
         # See later section on "Git repo for storage".
         storage-repo: https://${{ secrets.FILHELPER_PAT }}@github.com/filecoin-project/ref-fvm-fuzz-corpora.git
-        storage-repo-branch: lite
+        storage-repo-branch: master
         storage-repo-branch-coverage: gh-pages  # Optional. Defaults to "gh-pages".
     - name: Run Fuzzers (${{ matrix.sanitizer }})
       id: run
@@ -43,6 +43,6 @@ jobs:
         # batch fuzzing.
         # See later section on "Git repo for storage".
         storage-repo: https://${{ secrets.FILHELPER_PAT }}@github.com/filecoin-project/ref-fvm-fuzz-corpora.git
-        storage-repo-branch: lite
+        storage-repo-branch: master
         storage-repo-branch-coverage: gh-pages  # Optional. Defaults to "gh-pages".