https://github.com/ydah/rubocop-todo-regenerator

Custom action to regenerate `.rubocop_todo.yml` and create Pull Request.
https://github.com/ydah/rubocop-todo-regenerator

actions github-action github-actions rubocop

Last synced: 4 days ago
JSON representation

Custom action to regenerate `.rubocop_todo.yml` and create Pull Request.

• Host: GitHub
• URL: https://github.com/ydah/rubocop-todo-regenerator
• Owner: ydah
• Created: 2022-09-12T10:09:06.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-11T08:42:52.000Z (10 months ago)
• Last Synced: 2024-09-25T15:37:41.955Z (8 days ago)
• Topics: actions, github-action, github-actions, rubocop
• Homepage: https://github.com/ydah/rubocop-todo-regenerator
• Size: 13.7 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# rubocop-todo-regenerator

[Custom action](https://docs.github.com/en//actions/creating-actions/about-custom-actions) to regenerate `.rubocop_todo.yml` and create Pull Request.

## Usage

An example workflow to run rubocop-todo-regenerator via adding labels to pull requests.

```yaml

# .github/workflows/rubocop-todo-regenerator.yml

name: rubocop-todo-regenerator

on:

  pull_request:

    types: [labeled]

jobs:

  run:

    runs-on: ubuntu-latest

    steps:

      - uses: ydah/rubocop-todo-regenerator@main

        with:

          github_token: ${{ secrets.WRITABLE_GITHUB_TOKEN }}

```

## 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

### `triggered_label`

- Specify the label to be triggered.

- default: `rubocop-todo-regenerate`

- optional

### `preparation_command`

- Specify the label to be triggered.

- default: `""` (empty string means no op)

- optional