A Github action to run brakeman.
Create Github workflow definition yaml file in .github/workflows directory of your repository.
This action can be configured by the following input parameters.
| name | require | default | description |
|---|---|---|---|
| path | false | '.' |
Relative path to scan. |
| options | false | '--no-progress --no-exit-on-warn --no-exit-on-error --color -o /dev/stdout -o ${GITHUB_WORKSPACE}/brakeman_results.html' |
Additional options. |
see brakeman options.
The followoing yaml is a simplest workflow difinition of using brakeman-action.
name: Brakeman
on:
pull_request:
types: [opened, synchronize]
jobs:
Brakeman:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
# Ruby 3
- uses: macchiang/brakeman-action@v3