hohn/sarif-cli
1
0
Fork 0
mirror of https://github.com/hohn/sarif-cli.git synced 2025-12-16 17:23:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README for CLI usage instructions

Browse Source
This commit is contained in:
Kristen Newbury
2022-12-13 18:32:34 -05:00
parent 04a5aae14d
commit 202f7f53a5
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -5,6 +5,23 @@
The tool was implemented using Python 3.9. The tool was implemented using Python 3.9.
# Sarif format information
The tool operates on sarif generated by LGTM 1.27.0 (by default) or by the CodeQL CLI (enabled with the -f flag given a value of `CLI`).
The values that the -f flag accepts are: `LGTM` and `CLI`.
The CLI versions used against development of the CLI support were: 2.6.3, 2.9.4, and 2.11.4.
The CLI sarif **MUST** contain one additional property `versionControlProvenance` - which needs to look like:
```
"versionControlProvenance": [
{
"repositoryUri": "https://github.com/testorg/testrepo.git",
"revisionId": "testsha"
}
```
# Test Setup # Test Setup
This repository includes some test data (in `data`) and uses =git lfs= for storing those test files; installation steps are at This repository includes some test data (in `data`) and uses =git lfs= for storing those test files; installation steps are at
[[https://git-lfs.github.com][git-lfs]]; on a mac with homebrew, install it via [[https://git-lfs.github.com][git-lfs]]; on a mac with homebrew, install it via