Allow yaml extension for inventory and requirements

[netsandbox]

No description provided.

[ssbarnea]

Thanks for raising it, now we need to think a little bit about the implications.

The title is a little bit misleading because the tool does already recognize .yaml extension very well, is only the ansible specific config files which use only the default/documented extension. That was by design and not a mistake.

I am not sure we want to allow this because using these extensions will likely break LOTS of tools in the ecosystem, as most of them only recognize one filename.

We might require documentation proof that these extensions are allowed. The fact that they might happen to work, may not be enough. I mention this because recently we faced some other request about things that were never documented as being supported/allowed.

Keep in mind that it is summer, so we might need to wait a little bit more when we have to make a decision. Meanwhile you can configure overrides in your ansible-lint config as a workaround.

@cidrblock WDYT?

[netsandbox]

The title is a little bit misleading because the tool does already recognize .yaml ...

I have updated the title.

I am not sure we want to allow this because using these extensions will likely break LOTS of tools in the ecosystem, as most of them only recognize one filename.

We are talking here about Ansible and Ansible always support both, .yml and .yaml extension.
And if Ansible support both extension, ansible-lint also have to.

Sadly Ansible still defaults to the .yml extension, while YAML themself recommends using the .yaml extension:
https://yaml.org/faq.html

Also while Ansible support both extensions, sadly there is no mention of this in the documentation.

[netsandbox]

For example for inventory, it is documented in the plugin:
https://github.com/ansible/ansible/blob/4bd7e50612d4bff228506ea6f419abe2935bb04d/lib/ansible/plugins/inventory/yaml.py#L21-L25

and also in the schema:
https://github.com/ansible/schemas/blob/a5b163c41ebcfa6f88cfa23c0734671a21ad3bbf/f/ansible-inventory.json#L49-L53

[cognifloyd]

Yeah, I hate how ansible defaults to .yml in so many places. But, at least for galaxy.yml, that's required.

[netsandbox]

I also reverted .config/ansible-lint.yml which also doesn't support the .yaml extension 😢 :

ansible-lint/src/ansiblelint/cli.py

Line 100 in 4c4eb53

project_filenames = [".ansible-lint", ".config/ansible-lint.yml"]

So there are only inventory and requirements files left.

[cognifloyd]

Both inventory and requirements files are entirely user defined. Ansible only uses them if someone explicitly listed them in a config file, env var, or cli arg. So, we should support .yaml at least for those.

I require my team to use .yaml for inventory files and anything else that is allowed to avoid the legacy .yml extension.

[ssbarnea]

I do have some doubts that you will be able to upload collections to galaxy using a requirements.yaml file instead of requirements.yml. Someone needs to try it.