Skip to content

Fix spacing warnings in deprecation files

Amy Qualls requested to merge aqualls-fix-spacing into master

What does this MR do?

As part of working on !136388 (merged) it was tough to find the error that needed fixing, because the results were littered with so many spacing-related warnings. This MR fixes most (all?) of the problem files in the data/deprecations directory.

It also renames a file that started with two spaces. (!?) I kept trying to tab-complete to get the file from the CLI and kept getting file-not-found. Finally realized the problem with ls -lah.

To see the job output and why I chose to act: https://gitlab.com/gitlab-org/gitlab/-/jobs/5494639235 or expand this section:

Find the one line that's an error
$ yamllint -d "{extends: default, rules: {line-length: disable, document-start: disable}}" $LINT_PATHS
.gitlab/ci/rules.gitlab-ci.yml
  934:47    warning  too few spaces before comment  (comments)
  1592:5    warning  comment not indented like content  (comments-indentation)
  1631:34   warning  too few spaces before comment  (comments)
  1687:47   warning  too few spaces before comment  (comments)
.gitlab/ci/frontend.gitlab-ci.yml
  70:67     warning  too few spaces before comment  (comments)
.gitlab/ci/rails.gitlab-ci.yml
  64:24     warning  too few spaces before comment  (comments)
  78:24     warning  too few spaces before comment  (comments)
  351:23    warning  too few spaces before comment  (comments)
  352:34    warning  too few spaces before comment  (comments)
  360:25    warning  too few spaces before comment  (comments)
  366:35    warning  too few spaces before comment  (comments)
  368:33    warning  too few spaces before comment  (comments)
  370:44    warning  too few spaces before comment  (comments)
  382:34    warning  too few spaces before comment  (comments)
  395:46    warning  too few spaces before comment  (comments)
  397:44    warning  too few spaces before comment  (comments)
  399:55    warning  too few spaces before comment  (comments)
  411:36    warning  too few spaces before comment  (comments)
  412:43    warning  too few spaces before comment  (comments)
  419:38    warning  too few spaces before comment  (comments)
  426:44    warning  too few spaces before comment  (comments)
  428:51    warning  too few spaces before comment  (comments)
  430:46    warning  too few spaces before comment  (comments)
  437:36    warning  too few spaces before comment  (comments)
  439:47    warning  too few spaces before comment  (comments)
  441:31    warning  too few spaces before comment  (comments)
  443:37    warning  too few spaces before comment  (comments)
  445:38    warning  too few spaces before comment  (comments)
  447:33    warning  too few spaces before comment  (comments)
.gitlab/ci/database.gitlab-ci.yml
  75:17     warning  too few spaces before comment  (comments)
.gitlab/ci/global.gitlab-ci.yml
  39:16     warning  too few spaces before comment  (comments)
  49:16     warning  too few spaces before comment  (comments)
  232:27    warning  too few spaces before comment  (comments)
  502:24    warning  too few spaces before comment  (comments)
.gitlab/ci/templates/gem.gitlab-ci.yml
  21:11     warning  comment not indented like content  (comments-indentation)
.gitlab/ci/test-on-gdk/main.gitlab-ci.yml
  30:25     warning  too few spaces before comment  (comments)
.gitlab/ci/review-apps/main.gitlab-ci.yml
  48:40     warning  too few spaces before comment  (comments)
  51:43     warning  too few spaces before comment  (comments)
  101:40    warning  too few spaces before comment  (comments)
  103:43    warning  too few spaces before comment  (comments)
lib/gitlab/ci/templates/Cosign.gitlab-ci.yml
  15:24     warning  too few spaces before comment  (comments)
  17:24     warning  too few spaces before comment  (comments)
data/deprecations/16-0-deprecate-omnibus-grafana.yml
  22:10     warning  too few spaces before comment  (comments)
data/deprecations/16-1-windows-cmd-runner-shell-executor.yml
  5:30      warning  too few spaces before comment  (comments)
  8:17      warning  too few spaces before comment  (comments)
  9:67      warning  too few spaces before comment  (comments)
  13:37     warning  too few spaces before comment  (comments)
data/deprecations/16-4-ci_job_token_scope_enabled-attribute-deprecation.yml
  10:67     warning  too few spaces before comment  (comments)
data/deprecations/16-1-unified-approval-rules.yml
  27:91     warning  too few spaces before comment  (comments)
data/deprecations/16-6-lfs-integrity-check-feature-flag-deprecation.yml
  10:1      error    trailing spaces  (trailing-spaces)
data/deprecations/  16_3_runner-terminationgracepriodseconds.yml
  1:95      warning  too few spaces before comment  (comments)
  2:29      warning  too few spaces before comment  (comments)
  3:34      warning  too few spaces before comment  (comments)
  4:26      warning  too few spaces before comment  (comments)
  5:22      warning  too few spaces before comment  (comments)
  6:16      warning  too few spaces before comment  (comments)
  17:34     warning  too few spaces before comment  (comments)
  21:36     warning  too few spaces before comment  (comments)
  22:81     warning  too few spaces before comment  (comments)
data/deprecations/16_2-custom_sign_in_fields.yml
  1:77      warning  too few spaces before comment  (comments)
  2:34      warning  too few spaces before comment  (comments)
  3:35      warning  too few spaces before comment  (comments)
  4:29      warning  too few spaces before comment  (comments)
  5:30      warning  too few spaces before comment  (comments)
  6:25      warning  too few spaces before comment  (comments)
  7:25      warning  too few spaces before comment  (comments)
  8:17      warning  too few spaces before comment  (comments)
  9:75      warning  too few spaces before comment  (comments)
Cleaning up project directory and file based variables
00:01
ERROR: Job failed: exit code 1

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Amy Qualls

Merge request reports