init changelog config should be in proper yaml

[sean-m-sullivan]

Added changelog to a new collection then ran ansible-lint against it. Had the following errors:

WARNING  Listing 5 violation(s) that are fatal
changelogs/config.yaml:1: yaml[document-start]: Missing document start "---"
changelogs/config.yaml:14: yaml[indentation]: Wrong indentation: expected 2 but found 0
changelogs/config.yaml:32: yaml[document-end]: Missing document end "..."
Error: Missing document start "---"
Error: Wrong indentation: expected 2 but found 0
Error: Missing document end "..."

This should be updated to be proper yaml.

[felixfontein]

How do you define "proper YAML"? All YAML parsers I know off don't require the above things your linter mentioned.

[sean-m-sullivan]

Let me check it on whats enabled in ansible-lint Prod profile, as this is an Ansible Tool, that is what it should adhere to.

[djdanielsson]

its in our yaml lint rules

[felixfontein]

Closing since this seems more like a problem with ansible-lint or yamllint.

[gotmax23]

We use PyYAML to dump yaml files. The indentation linting errors are from that. ruamel.yaml does handle this properly, but I don't think this on its own is a compelling reason to switch yaml libraries and pull in another dependency. Fix these linting errors by hand if you'd like or just add that file to the linter's ignore list. The file is still perfectly valid yaml.

It would be trivial to add --- document starts, though. @felixfontein, wdyt?

[felixfontein]

I don't see why it is necessary, but that would be possible.

[sean-m-sullivan]

Let me get back to this, as I think some of it was our own rules, and some of it was ansible lint. if its done with the pyaml dump thats fine, just thought we should be putting out things that eat our own dogfood with ansilbe-lint.

[djdanielsson]

the requirement of the --- and ... is in our rules because it is correct yaml syntax but is not part of the production profile so I think it is most likely fine to just leave it how it is because most people don't seem to care about requiring --- and ...