Skip to content

Replace yamllint with yaml-lint

Evan Read requested to merge eread/replace-yamllint-with-yaml_lint into main

What does this MR do and why?

As noted at: !39 (comment 1819620996), it can be tricky to get yamllint set up correctly.

Instead, we can use an Node.js package (yaml-lint) which is trivial for folks to set up and allows us to have an SSoT for the version.

CC @axil

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md.
  2. Check out this branch.
  3. Render any of the YAML files in the project invalid.
  4. Run make lint-yaml. You should get an error.
  5. Reverse the changes made to YAML files.
  6. Run make lint-yaml. You should get no error.

Merge request acceptance checklist

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

Merge request reports