A GitHub Action to run Rubocop against your code and create annotations in the GitHub UI.
GitHub Actions are an amazing new tool that can dramatically improve productivity while using the GitHub platform. While it is not hard to write a custom GitHub action to run Rubocop on your codebase, this action takes that functionality one step further using the checks API. After the Rubocop Linter Action runs Rubocop against your code, it will create annotations that you can easily view, matched up with the offending code.
Since GitHub actions and the checks API are continually changing, it is possible that there will be breaking API changes that affect this action. If so, please open an issue and I will look into it as soon as I can.
Add the following to your GitHub action workflow to use Rubocop Linter Action:
- name: Rubocop Linter
uses: andrewmcodes/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Here is an example workflow file incorporating Rubocop Linter Action:
name: Rubocop
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Rubocop Linter
uses: andrewmcodes/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Due to the GitHub Check Runs API, we can only return 50 annotations per run. See here for more info.
This project was originally forked from gimenete/rubocop-action. Many thanks to Alberto Gimeno for creating this project.
Thanks goes to these wonderful people (emoji key):
 Andrew Mason 🚇 👀 📖 💻 |
 Miguel Savignano 🚇 |
 Dan McGregor 📖 |
 amerritt14 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!