Advice for configuring rubocop-shopify with Github Actions/Workflows

[jcohenho]

I'm trying to add rubocop-shopify to our Github workflows, but the output gives me different errors from my local and appears to be using normal Rubocop instead. For example, I'm getting an error regarding Layout/SpaceInLambdaLiteral, but this is not configured in the latest Shopify cop config. Would you be able to share any advice on how best to configure/integrate rubocop-shopify into Github actions/workflows?

Here is my workflow.yml config:

env:
  RUBY_VERSION: 2.7.2

name: Rubocop checks
on: [pull_request]
jobs:
  rubocop-test:
    name: Rubocop
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: ${{ env.RUBY_VERSION }}
      - name: Install Rubocop
        run: |
          gem install rubocop-shopify
          gem install rubocop-performance
          gem install rubocop-rails
          gem install rubocop-rspec
      - name: Check code
        run: rubocop

[flavorjones]

@jcohenho Can you share your .rubocop.yml file? I expect you'll need something like this to ensure everything is working:

require:
  - rubocop-rspec
  - rubocop-rails
  - rubocop-performance
inherit_gem:
  rubocop-shopify: rubocop.yml

[jcohenho]

This is my .rubocop.yml file:

inherit_from: .rubocop_todo.yml

inherit_gem:
  rubocop-shopify: rubocop.yml

require:
  - rubocop-performance
  - rubocop-rails
  - rubocop-rspec

[flavorjones]

You may want to make sure you are loading the correct environment by using Bundler within the github action. If that's not working, can you provide some more information to help folks reproduce what you're seeing?

[jcohenho]

@flavorjones I figured it out - my local bundle was using an older version of rubocop, and was out of sync from the later version being installed via the workflow. The diff in the rubocop_todo.yml from different versions was causing the failure.

Does rubocop-shopify require the installation of rubocop, either via gem install rubocop or via the Gemfile? I'd like to keep it locked to a specific version to avoid this in the future, but unsure if I should be locking rubocop or rubocop-shopify itself. Hope that makes sense, and thank you for your help!

[vergilet]

Hi Guys,
@jcohenho @flavorjones
How can I run the rubocop in Github Actions only for changed files in PR?

[nvasilevski]

Hey @vergilet 👋
I believe we are running rubocop against all files on CI because it's quick enough and in my experience is has a very efficient cache
However we do have an option to run rubocop locally against only changed files, conceptually it looks like `bundle exec rubocop which in a very primitive form may look like:

bundle exec rubocop $(git show --pretty="" --name-only | tr '\n' ' ')

I have to admit I'm really bad at bash so please only consider it as an example. Ideally we should be using git status --porcelain to build a list of changed files and pass it to rubocop.

Perhaps you might be interested in https://github.com/prontolabs/pronto-rubocop to avoid building your own solution

[vergilet]

Many thanks!