-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README.md: Tweak GitHub actions description
Signed-off-by: David A. Wheeler <[email protected]>
- Loading branch information
1 parent
b7e8ebe
commit e0d8827
Showing
1 changed file
with
12 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -94,15 +94,18 @@ vulnerabilities in programs that cannot be built or cannot be linked. | |
Flawfinder also doesn't get as confused by macro definitions | ||
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 | ||
|
||
See [action.yml](https://github.com/david-a-wheeler/flawfinder/blob/main/action.yml) | ||
|
||
Create a .yml file under .github/workflows with the following contents: | ||
|
||
### Basic: | ||
### Basic demo: | ||
|
||
```yml | ||
- name: Flawfinder | ||
uses: david-a-wheeler/[email protected] | ||
|
@@ -111,10 +114,14 @@ Create a .yml file under .github/workflows with the following contents: | |
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: | ||
- arguments: Flawfinder command arguments. | ||
Visit https://github.com/david-a-wheeler/flawfinder/blob/master/README.md#usage to check all parameters. | ||
- output: Flawfinder output file name. Can be uploaded to Github. | ||
|
||
- 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. | ||
|
||
# Contributions | ||
|
||
|