diff --git a/README.md b/README.md index ecee12c..22f261c 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,26 @@ - - - -[](#contributors) +## Brakeman github action -# Rubocop Linter Action +### Usage -GitHub Action to run Rubocop against your code and create annotations in the UI. - -**NOTE: due to the GitHub Check Runs API, we can only return 50 annotations per run. See [here](https://developer.github.com/v3/checks/runs/#output-object) for more info.** - -## Usage - -Add the following to your GitHub action workflow: - -```yaml -- name: Rubocop Linter - uses: andrewmcodes/rubocop-linter-action@v1.0.0 +```yml +- name: Brakeman + uses: devmasx/brakeman-lint-action@v1.0.0 env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} ``` -## Example Workflow +### Custom report -```yaml -name: Rubocop - -on: [push] - -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Rubocop Linter - uses: andrewmcodes/rubocop-linter-action@v1.0.0 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +```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-lint-action@v1.0.0 + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + REPORT_PATH: tmp/brakeman.json ``` - -## Screenshots - - - -## Contributing - -[Contributing Guide](/CONTRIBUTING.md) - -## Code of Conduct - -[Code of Conduct](/CODE_OF_CONDUCT.md) - -## License - -[MIT](/LICENSE.md) - -## Recognition - -This project was originally forked from [gimenete/rubocop-action](https://github.com/gimenete/rubocop-action). Many thanks to [Alberto Gimeno](https://github.com/gimenete) for creating this project. - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - -
Andrew Mason 🚇 👀 📖 💻 |
- Miguel Savignano 🚇 ⚠️ 💻 |
- Dan McGregor 📖 |
-