Skip to content

Commit

Permalink
Add docs for updating warning codes in SAPP DB and outputting a filte…
Browse files Browse the repository at this point in the history
…red run in SARIF

Reviewed By: gbleaney

Differential Revision: D30392990

fbshipit-source-id: d1b6505648450a8217b856e90f47c14da1a00b64
  • Loading branch information
0xedward authored and facebook-github-bot committed Aug 26, 2021
1 parent 876915e commit b503938
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,16 @@ You can also apply a list of filters to a single list of issues by run number. S
[~/example]$ sapp --database-name sapp.db filter issues 1 path/to/list_of_filters
```

#### SARIF Output
You can get the output of a filtered run in [SARIF](https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning#about-sarif-support) by first storing warning codes information from the static analysis tool in SAPP:
```shell
sapp --database-name sapp.db update warning-codes taint-metadata.json
```

Then running `sapp filter issues` with `--output-format=sarif`:
```shell
sapp --database-name sapp.db filter issues 1 path/to/list_of_filters --output-format sarif
```

## Development Environment Setup
Start by cloning the repo and setting up a virtual environment:
Expand Down

0 comments on commit b503938

Please sign in to comment.