This repository has been archived on 2023-10-25. You can view files and clone it, but cannot push or open issues or pull requests.
Miguel Savignano 721ede0fe0 update readme
2019-11-01 19:09:26 +01:00

30 lines
651 B
Markdown

## Brakeman github action
Brakeman is a static analysis tool which checks Ruby on Rails applications for security vulnerabilities.
[See more](https://github.com/presidentbeef/brakeman)
### Usage
```yml
- name: Brakeman
uses: devmasx/brakeman-linter-action@v1.0.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
```
### Custom report
```yml
- name: Install gems
run: |
gem install brakeman -v 4.5.0
- name: brakeman report
run: |
brakeman -f json > tmp/brakeman.json || exit 0
- name: Brakeman
uses: devmasx/brakeman-linter-action@v1.0.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
REPORT_PATH: tmp/brakeman.json
```