Skip to content

Upgrade `gitlab-styles` to 9.1.0

David Dieulivol requested to merge ddieulivol-gitlab_styles_9.1.0 into master

What does this MR do and why?

This MR upgrade gitlab-styles to 9.1.0. See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/releases/v9.1.0.

Previously this MR has been used to validate the upcoming release of gitlab-styles 9.1.0. See gitlab-org/ruby/gems/gitlab-styles!133 (merged).

See the checklist 👇 for more details.

Checklist

  • Verify upcoming release of gitlab-styles
    • Point to "Release" MR of gitlab-styles in Gemfile
      • For example, gem 'gitlab-styles', '~> 9.1.0', require: false, git: 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles.git', ref: 'ddieulivol-upgrade_to_9.1.0'
    • Update bundler's checksum file via bundle exec bundler-checksum init
    • rubocop job
      • Inspect any warnings/errors
      • (Optional) Generate TODOs for pending offenses
        • Put 🆕 cop rules (or if configuration is changed) in "grace period". See docs.
        • Use rg -r '$1' -o ":\d+\d+: \w: \[\S+\] (\S+):" raw_job_output.log | sort uniq to get a list of cop rules with offenses. Where raw_job_output.log is the raw log of the rubocop job
        • Ignore offenses related to temporary changes in Gemfile
      • (Optional) Remove any offenses for disabled cops
        • ❌ Remove TODOs for disabled RSpec/Predicate
      • [-] (Optional) Autocorrect offenses
      • Compare the total runtime of rubocop --parallel scan with previous runs
    • Make sure CI passes 💚
    • Don't merge this MR yet!
    • Wait for gitlab-styles to be released
  • Upgrade released version of gitlab-styles
    • Make sure release is complete
    • Rephrase the title and MR description to match final upgrade
    • Point to released version in Gemfile
      • gem 'gitlab-styles', '~> 9.1.0', require: false
      • Update bundler's checksum file via bundle exec bundler-checksum init
    • (Optional) Regenerate TODOs for new/changed cop rules
    • Make sure CI passes 💚
    • Let the MR being reviewed again and merged

How to set up and validate locally

bundle exec rubocop --parallel

or see the rubocop job in CI.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Peter Leitzen

Merge request reports