Mark the collection role module as deprecated #15455
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
component:awx_collection
|
Nice feedback from the sanity check! |
|
AlanCoding
commented
Aug 21, 2024
| deprecated: | ||
| remove_by_date: 2025-02-01 | ||
| why: Endpoints corresponding to module will be removed in the API | ||
| alternative: Use the role_user_assignment and role_team_assignment modules instead. |
There was a problem hiding this comment.
ERROR: plugins/modules/role.py:0:0: deprecation-mismatch: "meta/runtime.yml" and DOCUMENTATION.deprecation do not agree on removal date: '2025-02-01' vs. None
ERROR: plugins/modules/role.py:0:0: deprecation-wrong-collection: "DOCUMENTATION.deprecation.removed_from_collection must be the current collection name: None vs. 'awx.awx'
ERROR: plugins/modules/role.py:0:0: invalid-documentation: DOCUMENTATION.deprecated.remove_by_date: extra keys not allowed @ data['deprecated']['remove_by_date']. Got datetime.date(2025, 2, 1)
ERROR: plugins/modules/role.py:0:0: invalid-documentation: DOCUMENTATION.deprecated.removed_from_collection: required key not provided @ data['deprecated']['removed_from_collection']. Got None
ERROR: plugins/modules/role.py:0:0: invalid-documentation: DOCUMENTATION.deprecated.removed_in: required key not provided @ data['deprecated']['removed_in']. Got None
still not sure how/if we can do this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
SUMMARY
Work to add new, replacement, modules has already been done in 3bb559d but that did not make it fully clear that the old module will be removed via the standard way of doing this.
Putting up this PR, hoping that the collection sanity test checks it properly.
ISSUE TYPE
COMPONENT NAME