Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
actually show plugin config warnings/deprecations #82593
base: devel
Are you sure you want to change the base?
actually show plugin config warnings/deprecations #82593
Changes from all commits
1da7c19
11ff0b9
b4a33ed
3b7a885
e81df3b
8d4e15f
b386f72
f28bf84
e3d7d55
f43a4bd
3ebf418
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since when is
deprecated
allowed for module option docs? Since this is new and intended, it should be mentioned in the changelog.(Also
schema.py
in this PR is still disallowing this forplugin_type == 'module'
.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They were allowed since deprecations were added for docs, but I don't think it has been used more than 1 or 2 times. I'll update schema too, not sure why that was disabled there, since 'per option deprecation' existed for modules much longer than for plugins.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
most of the time we just used aliases to rename an option and keep old name as alias/backwards compat, I don't think we've removed an option from a module since 1.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Option deprecations for modules were allowed, but documenting them with
deprecated
never was so far.I think this happened quite a lot, especially in collections, but also in ansible/ansible. Actually it even happened in ansible-core: 9f82fc2 Some removals from Ansible 2.9: 808bf02 88f0c85
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was, for most of Ansible's lifetime there were no restrictions on docs, mostly a few requirements. The core engine still does not implement many restrictions.
The restrictions on docs are a relatively recent development in the 12yr lifetime of the project and part of CI/site docs build, not the runtime.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strict validation of module option docs (which effectively disallowed
deprecated
in it) was added in 04e816e, which is now there for a bit over 7 years. That's more than half of the 12 years you mentioned.