Skip to content
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

Collection docs linting: validate references to other plugins/modules/roles #157

Merged
merged 3 commits into from
Jun 10, 2023

Conversation

felixfontein
Copy link
Collaborator

@felixfontein felixfontein commented Jun 8, 2023

Right now, O() and RV() are only validated for references to the same plugin/module/role. This PR extends this functionality to also validate references to other plugins/modules/roles in the same collection - including checking whether the names supplied to M() and P() make sense -, and optionally also allows to check references to dependent collections.

(I plan to extend this to check all installed collections as well, maybe already in this PR before it's ready, or in a follow-up PR...)

Currently includes #155 and #156, will rebase once these have been merged.

@felixfontein felixfontein force-pushed the other-collections branch 3 times, most recently from 344d823 to 89a7ae8 Compare June 9, 2023 20:38
@felixfontein felixfontein marked this pull request as ready for review June 9, 2023 20:52
@felixfontein
Copy link
Collaborator Author

This now contains all the features I want (for this PR :) ).

@felixfontein felixfontein requested a review from briantist June 9, 2023 20:53
@felixfontein felixfontein changed the title [WIP] Collection docs linting: validate references to other plugins/modules/roles Collection docs linting: validate references to other plugins/modules/roles Jun 9, 2023
src/antsibull_docs/cli/antsibull_docs.py Outdated Show resolved Hide resolved
src/antsibull_docs/lint_plugin_docs.py Outdated Show resolved Hide resolved
@felixfontein felixfontein merged commit cd0e16a into ansible-community:main Jun 10, 2023
@felixfontein felixfontein deleted the other-collections branch June 10, 2023 21:19
@felixfontein
Copy link
Collaborator Author

@briantist thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants