rubocop-updater

Custom action to update RuboCop and regenerate .rubocop_todo.yml to exclude all newly added offense cops and create Pull Request.

If you are developing a Rails project, such as those listed below, we may be able to help you.

• It's a reasonably large Rails project
• Enabling pending Cops in bulk
• Many todo's remain in .rubocop_todo.yml.

This updater provides you with the automation of creating a PR for your upgrade that is secure and easy to see the differences.

Create a PR by creating a commit as follows:

• bundle exec rubocop --auto-gen-config (for once you have .rubocop_todo.yml cleanup)
• bundle update --conservative rubocop
• bundle exec rubocop --auto-gen-config

How it works?

Usage

An example workflow to run rubocop-updater via manual running.

# .github/workflows/rubocop-updater.yml
name: rubocop-updater
on:
  workflow_dispatch:
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: ydah/rubocop-updater@v0

Now you can run rubocop-updater via GitHub Actions page, or GitHub CLI like this:

gh workflow run rubocop-updater

Inputs

github_token

• GitHub access token to run another workflows from new pull request.
  • Don't forget to add workflow scope to this token
• optional

label

• Label to be given to the pull request.
• default: "" (empty string means no-label)

mode

• Switching modes of operation.
  • normal
  • quickly (Do not regenerate .rubocop_todo.yml to make it easier to see differences due to version changes)
• default: normal

update_target

• RuboCop (or extension) to be updated.
• default: rubocop

conservative_update

• If this option is true, then bundle update is performed as follows.
  • bundle update --conservative ${update_target}
• default: true

preparation_command

• Specify the label to be triggered.
• default: "" (empty string means no op)
• optional