update readme
This commit is contained in:
parent
7436a56daa
commit
78e98633e0
33
README.md
33
README.md
@ -1,34 +1,21 @@
|
||||
## 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)
|
||||
Check your coverage percentage.
|
||||
|
||||
### Usage
|
||||
|
||||
```yml
|
||||
- name: Brakeman
|
||||
uses: devmasx/brakeman-linter-action@v1.0.0
|
||||
env:
|
||||
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||
```
|
||||
|
||||
### Custom report
|
||||
#### [Simplecov](https://github.com/colszowka/simplecov)
|
||||
|
||||
```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
|
||||
- uses: devmasx/coverage-check-action@coverage-check
|
||||
with:
|
||||
result_path: coverage/.last_run.json
|
||||
token: ${{secrets.GITHUB_TOKEN}}
|
||||
type: simplecov
|
||||
min_coverage: 90
|
||||
```
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 70 KiB |
BIN
screenshots/fail.png
Normal file
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
BIN
screenshots/success.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
Reference in New Issue
Block a user