Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable new cops by default #581

Merged
merged 2 commits into from Oct 30, 2023
Merged

Disable new cops by default #581

merged 2 commits into from Oct 30, 2023

Conversation

sambostock
Copy link
Contributor

@sambostock sambostock commented Oct 6, 2023

Shopify's Ruby Style Guide disallows pending cops. That is, any time the development version of Rubocop is updated, any new pending cops will fail CI until we explicitly enable or disable them.

However, due to time between releases, consumers having upgraded Rubocop may end up triaging cops themselves to get rid of the pending cops message.

Therefore, this switches the config to disable new cops by default, in favour of waiting for us to triage them. Of course, consumers can always choose to override individual cops, or even this entire setting.


馃 This could be considered a breaking change, as the setting applies to all Rubocop cops, but we only triage and provide configuration for those in the main rubocop gem. This means that any apps wouldn't be warned about pending cops in plugins such as rubocop-rails.

sambostock and others added 2 commits October 6, 2023 02:08
Shopify's Ruby Style Guide disallows pending cops. That is, any time the development version of Rubocop is updated, any new pending cops will fail CI until we explicitly enable or disable them.

However, due to time between releases, consumers having upgraded Rubocop may end up triaging cops themselves to get rid of the pending cops message.

Therefore, this switches the config to disable new cops by default, in favour of waiting for us to triage them. Of course, consumers can always choose to override individual cops, or even this entire setting.
This automated commit dumps the contents of the full RuboCop config.
[dependabot skip]
@github-actions github-actions bot added the config change Changes the Rubocop config by enabling, disabling, or reconfiguring one or many cops label Oct 6, 2023
@rafaelfranca
Copy link
Member

This means that any apps wouldn't be warned about pending cops in plugins such as rubocop-rails.

That is fine. Most time people don't enable new cops in apps.

@rafaelfranca rafaelfranca marked this pull request as ready for review October 13, 2023 16:07
@rafaelfranca rafaelfranca requested a review from a team as a code owner October 13, 2023 16:07
@sambostock sambostock merged commit 631fa80 into main Oct 30, 2023
21 checks passed
@sambostock sambostock deleted the disable-new-cops branch October 30, 2023 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config change Changes the Rubocop config by enabling, disabling, or reconfiguring one or many cops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants