search

crytic / slither-action

GNU Affero General Public License v3.0
127 stars 19 forks source link

fix(action): output checklist #81

Closed sambacha closed 1 month ago

sambacha commented 5 months ago

Slither implies that the GitHub Action supports checklist output:

Checklist (consider using https://github.com/crytic/slither-action):
  --checklist           Generate a markdown page with the detector results
  --checklist-limit CHECKLIST_LIMIT
                        Limit the number of results per detector in the markdown file
  --markdown-root MARKDOWN_ROOT
                        URL for markdown generation

This PR does not implement checklist explicitly, as you can already get it by passing in the additional arguments option.

Adding the needed definition in the entrypoint.sh script would be explicit.

sambacha commented 1 month ago

Hi @sambacha! The action has no checklist output property, and this PR does not implement one either, so this PR is not correct as-is. The outputs section of action.yml should only have output variables -- i.e. variables that we add to $GITHUB_OUTPUT, like sarif and stdout.

We have an example of how to use the checklist functionality on our README if you're interested in using it: crytic/slither-action#example-workflow-markdown-report

Thank you for referring to the example. I came across this issue again and fixed it here https://github.com/crytic/slither/pull/2513

I actually find the SARIF output with the ToB VSCode Extension much more useful! Thank you for following up, much appreciated!