update readme

This commit is contained in:
Miguel Savignano 2019-11-02 23:18:39 +01:00
parent 7436a56daa
commit 78e98633e0
5 changed files with 10 additions and 23 deletions

View File

@ -1,34 +1,21 @@
## Brakeman github action ## Brakeman github action
Brakeman is a static analysis tool which checks Ruby on Rails applications for security vulnerabilities. Check your coverage percentage.
[See more](https://github.com/presidentbeef/brakeman)
### Usage ### Usage
```yml #### [Simplecov](https://github.com/colszowka/simplecov)
- name: Brakeman
uses: devmasx/brakeman-linter-action@v1.0.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
```
### Custom report
```yml ```yml
- name: Install gems - uses: devmasx/coverage-check-action@coverage-check
run: | with:
gem install brakeman -v 4.5.0 result_path: coverage/.last_run.json
- name: brakeman report token: ${{secrets.GITHUB_TOKEN}}
run: | type: simplecov
brakeman -f json > tmp/brakeman.json || exit 0 min_coverage: 90
- name: Brakeman
uses: devmasx/brakeman-linter-action@v1.0.0
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
REPORT_PATH: tmp/brakeman.json
``` ```
## Screenshots ## Screenshots
![example GitHub Action UI](./screenshots/action.png) ![Success](./screenshots/success.png)
![example Pull request](./screenshots/pull_request.png) ![Fail](./screenshots/fail.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

BIN
screenshots/fail.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 87 KiB

BIN
screenshots/success.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB