Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ydah/rubocop-updater
Custom action to update RuboCop and regenerate `.rubocop_todo.yml` to exclude all newly added offense cops and create Pull Request.
https://github.com/ydah/rubocop-updater
actions automation github-actions rubocop updater workflows
Last synced: 3 days ago
JSON representation
Custom action to update RuboCop and regenerate `.rubocop_todo.yml` to exclude all newly added offense cops and create Pull Request.
- Host: GitHub
- URL: https://github.com/ydah/rubocop-updater
- Owner: ydah
- License: mit
- Created: 2022-05-19T02:28:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T14:52:52.000Z (about 2 years ago)
- Last Synced: 2024-05-02T02:57:35.060Z (8 months ago)
- Topics: actions, automation, github-actions, rubocop, updater, workflows
- Homepage:
- Size: 325 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# rubocop-updater
[Custom action](https://docs.github.com/en//actions/creating-actions/about-custom-actions)
to update [RuboCop](https://github.com/rubocop/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.
- [x] It's a reasonably large Rails project
- [x] [Enabling pending Cops in bulk](https://docs.rubocop.org/rubocop/versioning.html#enablingdisabling-pending-cops-in-bulk)
- [x] 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](https://docs.github.com/en//actions/managing-workflow-runs/manually-running-a-workflow).
```yaml
# .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](https://cli.github.com/) 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