diff --git a/README.md b/README.md index b1a3f2b..80adf39 100644 --- a/README.md +++ b/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 -![example GitHub Action UI](./screenshots/action.png) -![example Pull request](./screenshots/pull_request.png) +![Success](./screenshots/success.png) +![Fail](./screenshots/fail.png) diff --git a/screenshots/action.png b/screenshots/action.png deleted file mode 100644 index 6fc094c..0000000 Binary files a/screenshots/action.png and /dev/null differ diff --git a/screenshots/fail.png b/screenshots/fail.png new file mode 100644 index 0000000..07f4369 Binary files /dev/null and b/screenshots/fail.png differ diff --git a/screenshots/pull_request.png b/screenshots/pull_request.png deleted file mode 100644 index fbb0634..0000000 Binary files a/screenshots/pull_request.png and /dev/null differ diff --git a/screenshots/success.png b/screenshots/success.png new file mode 100644 index 0000000..94383db Binary files /dev/null and b/screenshots/success.png differ