search

ansible / ansible-lint

ansible-lint checks playbooks for practices and behavior that could potentially be improved and can fix some of the most common ones for you
https://ansible.readthedocs.io/projects/lint/
GNU General Public License v3.0
3.46k stars 656 forks source link

integrate collection documentation regeneration #1818

Open ssbarnea opened 2 years ago

ssbarnea commented 2 years ago

We should integrated https://github.com/ansible-network/collection_prep into ansible-lint as a default feature for collections.

ansible-lint is already used to certify collections and having one less tool to run would only benefit everyone.

The expectation is that if the placeholders are missing we don't need to generate docs but later we could check if current repository is a collection and display a warning if the placeholders are missing.

This will likely work well even with pre-commit.ci auto-fixing.

MarkusTeufelberger commented 2 years ago

Please don't.

A linter should be a static code checker, not a documentation generation tool in my opinion. It would be nice to mention that other project as something that one could run of course, but they even already provide a hook for the pre-commit tool: https://github.com/ansible-network/collection_prep/blob/master/.pre-commit-hooks.yaml