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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

4.0.0 pre-release issues #129

Closed
4 of 5 tasks
kevindew opened this issue Feb 19, 2021 · 1 comment
Closed
4 of 5 tasks

4.0.0 pre-release issues #129

kevindew opened this issue Feb 19, 2021 · 1 comment

Comments

@kevindew
Copy link
Member

kevindew commented Feb 19, 2021 •
edited
Loading

With the 4.0.0 changes to rubocop-govuk there are quite a lot of new rules (1, 2) which make us unsure how big the impact will be for GOV.UK. Therefore we are releasing this version as a pre-release to help identify whether it presents any particular challenges for GOV.UK codebases before a wider release.

The approach to adding new rules is to favour consistency with the default rules of the upstream libraries (rubocop, rubcop-rails, etc) over individual opinions on approaches. We've aimed to disable only rules that would produce significant problems in applying to the GOV.UK codebase.

In this pre-release we should ensure that we test

  • Frequently changed big GOV.UK apps (for example: Whitehall, Publishing API, Smart Answers
  • Some older and less loved GOV.UK apps (for example: licence-finder, bouncer)
  • Newer GOV.UK apps that represent current patterns (for example: Content Publisher, Email Alert API)
  • Apps/utilities that don't use Rails (for example Search API, Cache Clearing Service, GOV.UK Developer Docs, Content Schemas)
  • GOV.UK Gems (for example govuk_publishing_components, govuk_app_config)

To install this pre-release in app you need to update the Gemfile accordingly:

gem "rubocop-govuk, "4.0.0.pre-1"

This thread can be used to raise any concerns regarding these new rules, particularly where they conflict with GOV.UK conventions or require so many changes adoption will be very difficult.

Initially there have been 2 rules that have proved divisive, where wider opinions are welcomed, these are: Lint/MissingSuper and Lint/UselessMethodDefinition. There are also some concerns that these rules could be difficult to apply are Gemspec/RequiredRubyVersion, Style/CombinableLoops, Style/HashLikeCase. So it'd be good to learn if these are too painful to apply consistently.
kevindew added a commit that referenced this issue Feb 19, 2021
@kevindew
Release as 4.0.0.pre-1
4bf3a99 
This is a pre-release of 4.0.0 that can be applied to a number of GOV.UK
applications to help understand whether applying this release is going
to be difficult for GOV.UK.

I've documented this further in a GitHub issue: #129
@kevindew kevindew mentioned this issue Feb 19, 2021
Merged
kevindew added a commit to alphagov/publishing-api that referenced this issue Feb 22, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
b193e11 
This is to test the pre-release out of 4.0.0. Further details are available
at: alphagov/rubocop-govuk#129
@kevindew kevindew mentioned this issue Feb 22, 2021
Merged
kevindew added a commit to alphagov/govuk_publishing_components that referenced this issue Feb 23, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
b4238ad 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/smart-answers that referenced this issue Feb 23, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
2654186 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/gds-api-adapters that referenced this issue Feb 24, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
53a3285 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
This was referenced Feb 24, 2021
Merged
Merged
kevindew added a commit to alphagov/search-api that referenced this issue Feb 25, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
6292d95 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/bouncer that referenced this issue Feb 25, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
1c2473e 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/licence-finder that referenced this issue Feb 25, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
88dc4cb 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129

I've also moved the rubocop-govuk gem into development/test since it
shouldn't be needed as part of production. I've also set the gem as
require false as per the README recommendation since the code of it is
not needed outside of running rubocop.
kevindew added a commit to alphagov/licence-finder that referenced this issue Feb 26, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
e11aef6 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129

I've also moved the rubocop-govuk gem into development/test since it
shouldn't be needed as part of production. I've also set the gem as
require false as per the README recommendation since the code of it is
not needed outside of running rubocop.
@kevindew kevindew mentioned this issue Feb 26, 2021
Merged
kevindew added a commit to alphagov/search-api that referenced this issue Feb 26, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
1121de1 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
This was referenced Feb 26, 2021
Merged
Merged
@peteryates peteryates mentioned this issue Feb 27, 2021
Merged
kevindew added a commit to alphagov/search-api that referenced this issue Mar 4, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
2166db1 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/cache-clearing-service that referenced this issue Mar 8, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
7acffc5 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/govuk-developer-docs that referenced this issue Mar 8, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
9f0d31d 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/govuk-developer-docs that referenced this issue Mar 9, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
ac0bf12 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
This was referenced Mar 9, 2021
Merged
Merged
kevindew added a commit to alphagov/govuk-developer-docs that referenced this issue Mar 12, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
758635e 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/whitehall that referenced this issue Mar 19, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
641a39c 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/whitehall that referenced this issue Mar 22, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
454765f 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
@kevindew kevindew mentioned this issue Mar 23, 2021
Merged
kevindew added a commit to alphagov/content-publisher that referenced this issue Apr 15, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
731dbce 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
@kevindew kevindew mentioned this issue Apr 15, 2021
Merged
kevindew added a commit to alphagov/content-publisher that referenced this issue Apr 26, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
4486e80 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
kevindew added a commit to alphagov/email-alert-api that referenced this issue May 5, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
2c0e3a7 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
@kevindew kevindew mentioned this issue May 5, 2021
Merged
This was referenced May 11, 2021
Closed
Merged
kevindew added a commit to alphagov/email-alert-api that referenced this issue May 17, 2021
@kevindew
Install rubocop-govuk 4.0.0.pre.1
fdc459f 
This is to test the pre-release out of 4.0.0. Further details are in:
alphagov/rubocop-govuk#129
@kevindew
Copy link
Member Author

kevindew commented Aug 5, 2021

rubocop-govuk 4 is out and widely deployed across GOV.UK

@kevindew kevindew closed this as completed Aug 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kevindew