walkero
/
flawfinder
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

README.md: Tweak GitHub actions description 

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
This commit is contained in:
David A. Wheeler 2021-06-29 19:28:09 -04:00
parent b7e8ebe3df
commit e0d8827c3b
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -94,7 +94,9 @@ vulnerabilities in programs that cannot be built or cannot be linked.
Flawfinder also doesn't get as confused by macro definitions Flawfinder also doesn't get as confused by macro definitions
and other oddities that more sophisticated tools have trouble with. and other oddities that more sophisticated tools have trouble with.
# Flawfinder Github Action # Flawfinder GitHub Action
There's a GitHub action available for those who use GitHub.
## Usage ## Usage
@ -102,7 +104,8 @@ See [action.yml](https://github.com/david-a-wheeler/flawfinder/blob/main/action.
Create a .yml file under .github/workflows with the following contents: Create a .yml file under .github/workflows with the following contents:
### Basic: ### Basic demo:
```yml ```yml
- name: Flawfinder - name: Flawfinder
uses: david-a-wheeler/flawfinder@v1.0 uses: david-a-wheeler/flawfinder@v1.0
@ -111,10 +114,14 @@ Create a .yml file under .github/workflows with the following contents:
output: 'flawfinder_results.sarif' output: 'flawfinder_results.sarif'
``` ```
You can add many other additions to the arguments.
For example, `--error-level=4` will cause an error to be returned if
flawfinder finds a vulnerability of level 4 or higher.
### Input options: ### Input options:
- arguments: Flawfinder command arguments.
Visit https://github.com/david-a-wheeler/flawfinder/blob/master/README.md#usage to check all parameters. - arguments: [Flawfinder command arguments](ttps://github.com/david-a-wheeler/flawfinder/blob/master/README.md#usage)
- output: Flawfinder output file name. Can be uploaded to Github. - output: Flawfinder output file name. Can be uploaded to GitHub.
# Contributions # Contributions