A GitHub Action to run Rubocop against your codebase and output the results in the GitHub Checks 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.

Please view the official documentation for more detailed instructions, including how to setup and use a configuration file to customize the action. Note that you can set the version for the documentation you are viewing in the bottom right.

Default usage, similar to running gem install rubocop && rubocop from your command line:

- name: Rubocop Linter Action
  uses: andrewmcodes/[email protected]
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View our Changelog

Contributing Guide

Code of Conduct

MIT

• andrewmcodes/haml-lint-action.
• andrewmcodes/standardrb-action.

Thanks goes to these wonderful people (emoji key):

Andrew Mason 🚇 👀 📖 💻	Miguel Savignano 🚇 ⚠️ 💻	Dan McGregor 📖	amerritt14 💻	Brian Bugh 💻 ⚠️	Reid Beels 💻 ⚠️	Christopher Pezza 💻 📖 🚇
Mark Havekes 🐛	David Martinez 💻	Chris Oliver 👀 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!