Skip to content

Commit

Permalink
Merge pull request #1 from jidicula/pr-1
Browse files Browse the repository at this point in the history
feat: Clarify that download requires GitHub CLI
  • Loading branch information
jidicula authored Apr 10, 2022
2 parents 14b662a + 968e59c commit 9fea35e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can sponsor me [here](https://github.com/sponsors/jidicula)!
## Returns:
* SUCCESS: if your fuzz tests don't raise a failure within the `fuzz-time` input constraint.
* FAILURE: if your fuzz tests raise a failure within the `fuzz-time` input constraint.
* The workflow run logs will include instructions on how to download the failing seed corpus to your local machine for remediation, regardless of run trigger.
* The workflow run logs will include instructions on how to download (using the [GitHub CLI](https://cli.github.com)) the failing seed corpus to your local machine for remediation, regardless of run trigger.
* If you run this Action in a PR workflow, it'll comment these instructions on your PR: <img width="864" alt="image" src="https://user-images.githubusercontent.com/12765385/162630131-9050221e-dc75-4620-aa19-d004d8678074.png">

# Usage
Expand All @@ -37,7 +37,7 @@ jobs:
name: Fuzz test
runs-on: ubuntu-latest
steps:
- uses: jidicula/go-fuzz-action@main
- uses: jidicula/go-fuzz-action@v1.1.0
with:
fuzz-time: 30s
```
Expand All @@ -56,7 +56,7 @@ jobs:
name: Fuzz test
runs-on: ubuntu-latest
steps:
- uses: jidicula/go-fuzz-action@main
- uses: jidicula/go-fuzz-action@v1.1.0
with:
packages: './...'
fuzz-time: 30s
Expand All @@ -76,7 +76,7 @@ jobs:
name: Fuzz test
runs-on: ubuntu-latest
steps:
- uses: jidicula/go-fuzz-action@main
- uses: jidicula/go-fuzz-action@v1.1.0
with:
packages: './...'
fuzz-time: 30s
Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ runs:
if: failure()
shell: bash
run: |
MESSAGE='Fuzz test failed on ${{ env.SHA }}. Download the seed corpus with\n```\ngh run download ${{ github.run_id }} -n testdata\n```'
MESSAGE='Fuzz test failed on ${{ env.SHA }}. Using the [GitHub CLI](https://cli.github.com), download the seed corpus with\n```\ngh run download ${{ github.run_id }} -n testdata\n```'
echo -e "$MESSAGE"
- name: Report failure
uses: actions/github-script@v6
Expand All @@ -67,5 +67,5 @@ runs:
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: 'Fuzz test failed on ${{ env.SHA }}. Download the seed corpus with\n```\ngh run download ${{ github.run_id }} -n testdata\n```'
body: 'Fuzz test failed on ${{ env.SHA }}. Using the [GitHub CLI](https://cli.github.com), download the seed corpus with\n```\ngh run download ${{ github.run_id }} -n testdata\n```'
})

0 comments on commit 9fea35e

Please sign in to comment.