diff --git a/.github/scripts/fuzz_report/templates/new_issue.md b/.github/scripts/fuzz_report/templates/new_issue.md index 435eb9bf8da..c5694543879 100644 --- a/.github/scripts/fuzz_report/templates/new_issue.md +++ b/.github/scripts/fuzz_report/templates/new_issue.md @@ -33,9 +33,14 @@ - **Commit**: {{COMMIT}} - **Crash Artifact**: {{ARTIFACT_URL}} -### Reproduction +### Reproduce + +```bash +cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0 +```
+First-time setup: download and extract the crash artifact 1. Download the crash artifact: - **Direct download**: {{ARTIFACT_URL}} @@ -44,52 +49,16 @@ - You can create a `./fuzz/artifacts` directory that will be git-ignored in the `vortex` repo - Full path would be `./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}}` -2. Reproduce locally: - -```bash -cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} /path/to/crash_file -- -rss_limit_mb=0 -``` - -3. Get a backtrace: - -```bash -RUST_BACKTRACE=1 cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} /path/to/crash_file -- -rss_limit_mb=0 -``` - -```bash -RUST_BACKTRACE=full cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} /path/to/crash_file -- -rss_limit_mb=0 -``` - -
- -### Workflow Example - -Assuming you download the zipfile to `~/Downloads`, and your working directory is the repository -root, you can follow these steps: - -
+2. Assuming you download the zipfile to `~/Downloads`, and your working directory is the repository root: ```bash -# Create the artifacts directory if you haven't already. mkdir -p ./fuzz/artifacts - -# Move the zipfile. mv ~/Downloads/{{FUZZ_TARGET}}-crash-artifacts.zip ./fuzz/artifacts/ - -# Unzip the zipfile. unzip ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip -d ./fuzz/artifacts/ - -# You can remove the zipfile now if you want to. rm ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip ``` -You can now reproduce with: - -```bash -cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0 -``` - -If you want a backtrace: +3. Get a backtrace: ```bash RUST_BACKTRACE=1 cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0