rubocop-action

This GitHub action runs rubocop and posts offences as inline comments on pull requests. When offences are resolved, the comments are fully deleted, making for clean pull requests without noisy history.

This action was created to replace the unmaintained Hound service from Thoughtbot.

Create a .github/workflows/rubocop.yml file in your repository:

name: Rubocop

on: pull_request

permissions:
  contents: read
  pull-requests: write

jobs:
  rubocop:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ruby/setup-ruby@v1
      - uses: reclaim-the-stack/rubocop-action@v1

The GitHub token to use for interacting with the GitHub API (eg. to managed comments). By default we use the token which is automatically provided by GitHub Actions.

By default rubocop / rubocop-rails and rubocop-rspec gems are installed. Check the action.yml file for the current default version of the gems installed by this action.

You can override the gems and versions either by:

Specifying gem_versions as Gemfile in which case we remove all gems except those with rubocop in their name (and syntax_tree) from your Gemfile and run bundle install, installing the versions locked in your Gemfile.lock. Rubocop is then run via bundle exec.

      - uses: reclaim-the-stack/rubocop-action@v1
        with:
          gem_versions: Gemfile

Specifying gem_versions in the standard gem install format.

      - uses: reclaim-the-stack/rubocop-action@v1
        with:
          gem_versions: rubocop:1.18.3 rubocop-rspec:2.0.0 rubocop-<some-other-plugin>:1.2.0

Allows you to pass additional arguments to rubocop. E.g.

      - uses: reclaim-the-stack/rubocop-action@v1
        with:
          rubocop_arguments: --config .rubocop.yml

The exit code used when offences are found. Defaults to 108. Set it to 0 to post comments on offences without failing the build.

      - uses: reclaim-the-stack/rubocop-action@v1
        with:
          failure_exit_code: 0

The v1 tag tracks the latest v1.x.x release. Pin to a specific release, e.g. reclaim-the-stack/rubocop-action@v1.2.0, if you prefer to opt in to updates manually.

We don't handle hitting API rate limits on the GitHub API. Presumably this could end up being a problem if you create a pull request with a ton of offences requiring inline comments. Shouldn't be a problem for normal use though.