New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve meta/main.yml documentation for roles #1241
Comments
This forum topic may have some helpful information as well - https://forum.ansible.com/t/role-meta-data-platform-key-broken/4651 It mentions an old galaxy api page which can be reached at https://old-galaxy.ansible.com/api/v1/platforms/ |
...continuing the linkfest of places that might have the details needed - https://github.com/ansible/ansible-lint/blob/main/src/ansiblelint/schemas/meta.json |
Discussed in DaWGs meeting: |
I removed the Not sure if this has been discussed elsewhere, but the related forum post appears to be about roles in collections, not standalone roles, and I'm not sure Galaxy and ansible-lint are in alignment on that (beyond Galaxy calling ansible-lint). I don't think a role in a collection can set a custom I did find a very brief mention of the |
We mention the role structure and some specific portions of
meta/main.yml
in https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#using-meta-main-yml but we don't define the whole thing anywhere in docs.The specifc trigger for this issue is a user getting an
ansible-lint
error of :meta-no-info: Role info should contain platforms
...and had no way to find out what this
platforms
section is about. In general, would be good to have a well-defined example of this in the docs.Perhaps an extension of https://github.com/ansible/ansible/blob/devel/lib/ansible/galaxy/data/apb/meta/main.yml.j2
The text was updated successfully, but these errors were encountered: