Replace yamllint with yaml-lint
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.
-
Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md. -
Check out this branch. -
Render any of the YAML files in the project invalid. -
Run make lint-yaml
. You should get an error. -
Reverse the changes made to YAML files. -
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.
-
I have evaluated the MR acceptance checklist for this merge request.