Lint and format the MMv1 resource definition YAML files in magic-modules/mmv1/products/
#13841
Labels
Milestone
magic-modules/mmv1/products/
#13841
Community Note
Description
There are some errors and lots of inconsistencies of syntax in the YAML files for the MMv1 resources under the directory
magic-modules/mmv1/products
.For example, running
yamllint
in themagic-modules/mmv1
directory emits the following counts of syntax errors and warnings:[error] duplication of key "readReplicasMode" in mapping
[warning] wrong indentation: expected 15 but found 14
[warning] trailing spaces
Although some of them are non-harmful for the production provider code, such errors and inconsistencies in the YAML code syntax should be regularly and automatically checked to prevent generation of unintended provider code, avoid noisy diff in pull requests, and reduce non-essential discussions over stylistic choices during code review.
Proposal
It would be nice to have a YAML linter in the CI workflows of magic-modules.
I am thinking of the introducing a YAML linter in the magic-modules repository by splitting the changes in the following three steps:
yamllint
CLI in thegcr.io/graphite-docker-images/downstream-builder
container image..yamllint
to ignore or temporarily suppress some non-critical errors.We will need to be careful when correcting the following duplicate-key YAML syntax errors so that it will not alter or break the currently generated provider code.
Affected Resource(s)
The text was updated successfully, but these errors were encountered: