Skip to content

Commit

Permalink
README.md: Tweak GitHub actions description
Browse files Browse the repository at this point in the history
Signed-off-by: David A. Wheeler <[email protected]>
  • Loading branch information
david-a-wheeler committed Jun 29, 2021
1 parent b7e8ebe commit e0d8827
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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

Expand Down

0 comments on commit e0d8827

Please sign in to comment.