46 lines
3 KiB
Markdown
46 lines
3 KiB
Markdown
|
<!-- Title suggestion: Upgrade `gilab-styles` to <VERSION X.Y.Z> - dry-run -->
|
||
|
|
|
||
|
|
## What does this MR do and why?
|
||
|
|
|
||
|
|
Validating upcoming release of `gitlab-styles` <VERSION X.Y.Z>. See <LINK TO RELEASE MR>.
|
||
|
|
|
||
|
|
This MR can be reused to upgrade `gitlab-styles` in this project after a new version of `gitlab-styles` is released.
|
||
|
|
### 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](https://docs.gitlab.com/ee/development/gemfile.html#updating-the-checksum-file) via `bundle exec bundler-checksum init`
|
||
|
|
- [ ] `rubocop` job
|
||
|
|
- [ ] Inspect any warnings/errors
|
||
|
|
- [ ] (Optional) [Generate TODOs](https://docs.gitlab.com/ee/development/contributing/style_guides.html#resolving-rubocop-exceptions) for pending offenses
|
||
|
|
- [ ] Put :new: cop rules (or if configuration is changed) in "grace period". See [docs](https://docs.gitlab.com/ee/development/contributing/style_guides.html#enabling-a-new-cop).
|
||
|
|
- [ ] (Optional) Remove any offenses for disabled cops
|
||
|
|
- Use `grep --perl-regexp -o ":\d+\d+: \w: \[\S+\] ([\w/]+)" raw_job_output.log | awk '{print $4}' | sort | uniq -c` to get a list of cop rules with offenses. Where `raw_job_output.log` is the raw output of the `rubocop` job
|
||
|
|
- [ ] Ignore offenses related to temporary changes in `Gemfile`
|
||
|
|
- [ ] (Optional) Autocorrect offenses
|
||
|
|
- [ ] Compare the total runtime of `rubocop --parallel` scan with previous runs
|
||
|
|
- [ ] Make sure CI passes :green_heart:
|
||
|
|
- [ ] 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](https://docs.gitlab.com/ee/development/gemfile.html#updating-the-checksum-file) via `bundle exec bundler-checksum init`
|
||
|
|
- [ ] (Optional) Regenerate TODOs for new/changed cop rules
|
||
|
|
- [ ] Make sure CI passes :green_heart:
|
||
|
|
- [ ] Let the MR being reviewed again and merged
|
||
|
|
- [ ] Make sure CI passes :green_heart:
|
||
|
|
- [ ] Let the MR being reviewed again and merged
|
||
|
|
- [ ] (Optional) Refine this [MR template](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/merge_request_templates/New%20Version%20of%20gitlab-styles.md).
|
||
|
|
|
||
|
|
## MR acceptance checklist
|
||
|
|
|
||
|
|
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
|
||
|
|
|
||
|
|
* [ ] I have evaluated the [MR acceptance checklist](https://docs.gitlab.com/ee/development/code_review.html#acceptance-checklist) for this MR.
|
||
|
|
|
||
|
|
/label ~"type::maintenance" ~"maintenance::dependency" ~backend ~"Engineering Productivity" ~"static code analysis"
|