Custom action to create a pull request that autocorrects offenses in .rubocop_todo.yml per cop.

Add the following workflow file to manually run the action:

# .github/workflows/rubocop-todo-corrector.yml
name: rubocop-todo-corrector

on:
  workflow_dispatch:
    inputs:
      cop_name:
        description: Pass cop name if you want to pick a specific cop.
        required: false
        type: string
      ignore:
        description: Check this with cop_name if you want to ignore a specific cop.
        required: false
        type: boolean
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: r7kamura/rubocop-todo-corrector@v0
        with:
          ignore: ${{ inputs.ignore }}

Now you can run it via actions page:

or if you want to do it from CLI, use GitHub CLI like this:

gh workflow run rubocop-todo-corrector

After the action is complete, a pull request is created as follows:

By adding on.pull_request event to the workflow, you can automatically run it when all other labeled pull requests are merged or closed.

 name: rubocop-todo-corrector

 on:
+  pull_request:
+     types:
+       - closed
   workflow_dispatch:
     inputs:
       cop_name:
         description: Pass cop name if you want to pick a specific cop.
         required: false
         type: string
       ignore:
         description: Check this with cop_name if you want to ignore a specific cop.
         required: false
         type: boolean
 jobs:
   run:
     runs-on: ubuntu-latest
     steps:
       - uses: r7kamura/rubocop-todo-corrector@v0
         with:
           ignore: ${{ inputs.ignore }}
+          label: rubocop-todo-corrector

Note that the label input is required to use this feature.

Don't forget to create the label on your repository before you run the action.

If you pass ignore as "true", the action will create a pull request that ignores the specified cop by appending specified cop_name to .rubocop_todo_corrector_ignore.

Note: You can ignore specific cops by adding a file named .rubocop_todo_corrector_ignore to your repository. See the following page for more details:

• https://github.com/r7kamura/rubocop_todo_corrector#rubocop_todo_corrector_ignore

• Pass cop name if you want to pick a specific cop.
• optional
  • Required if ignore is "true"
• e.g. "Style/NegatedIf"

• Additional options for gh pr create command.
• optional
• e.g. "--reviewer r7kamura --draft"

• GitHub access token for GitHub API calls.
• optional
  • Not required, but if you want to run another workflows from new pull request, you need to pass this token with workflow scope.

• Ignore specific cop instead.
• optional
• e.g. "true"

• Pull request label name.
• optional
• e.g. "rubocop-todo-corrector"
• Note: You need to create a label with this name on your repository.

• Mode to select autocorrected cop.
• default: random
• Choose from the following options:
  • "first"
  • "last"
  • "least_occurred"
  • "most_occurred"
  • "random"

• Exclude unsafe cops.
• default: "true"