Allow to deprecate options and aliases by date #68177
Merged
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
ansibot
added
WIP
felixfontein
changed the title
|
(The remaining CI failures are package download timeouts, i.e. unrelated :) ) ready_for_review |
ansibot
added
core_review
This was referenced Mar 15, 2020
|
TODO next:
|
ansibot
added
has_issue
needs_revision
felixfontein
force-pushed
the
deprecate-by-date
branch
from
6200ead
to
33bdd34
Compare
ansibot
added
needs_revision
|
@felixfontein What's the intended workflow for this feature? Deprecation by version seems obvious to me, but I'm not immediately coming up with a scenario for deprecation by date. |
…_aliases.date checks to validate-modules.
…eprecate() calls.
Co-authored-by: Jordan Borean <jborean93@gmail.com>
felixfontein
force-pushed
the
deprecate-by-date
branch
from
06a6579
to
2f19ea5
Compare
|
(Rebased so that the branch includes the changes from the routing PR, and changed behavior of |
jborean93
approved these changes
May 26, 2020
ansibot
added
needs_revision
nitzmahone
approved these changes
May 26, 2020
|
rebuild_merge |
mattclay
reviewed
May 27, 2020
Comment on lines
+94
to
+95
| if not re.match('^[0-9]{4}-[0-9]{2}-[0-9]{2}$', value): | ||
| raise ValueError(msg) |
There was a problem hiding this comment.
This logic appears to be redundant. The exception handler below should catch the same cases the regex does and return the same exception.
There was a problem hiding this comment.
The code below also accepts 2020-1-1, which is not ISO 8601. It does catch invalid dates such as 2019-02-29 though, which this regex won't catch.
mattclay
reviewed
May 27, 2020
Comment on lines
+208
to
+209
| if not re.match('^[0-9]{4}-[0-9]{2}-[0-9]{2}$', v): | ||
| raise ValueError(msg) |
There was a problem hiding this comment.
Same as previous comment about redundant logic.
ansibot
added
shipit
|
@mattclay @bcoca @sivel @jborean93 @nitzmahone thanks a lot for reviewing and merging! :) |
felixfontein
added a commit
to felixfontein/ansible
that referenced
this pull request
May 27, 2020
felixfontein
added a commit
to felixfontein/ansible
that referenced
this pull request
May 27, 2020
nitzmahone
pushed a commit
that referenced
this pull request
May 28, 2020
…make validate-modules ensure version and date match (#69727) * Allow to deprecate module by date in documentation. * Make sure deprecation date/version match between module docs and meta/runtime.yml. * Unrelated fix: don't compare deprecated module version to Ansible's version in collection. * Allow documentation's removal version to be something else than fixed list of Ansible versions for collections. * Linting. * Allow to deprecate plugin options by date. * Add changelog fragment for deprecation by date (also covers #68177).
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
Allows to deprecate options and aliases also by date and not only by version.
ISSUE TYPE
COMPONENT NAME
lib/ansible/module_utils/basic.py
lib/ansible/module_utils/common/parameters.py
lib/ansible/module_utils/common/warnings.py
lib/ansible/module_utils/csharp/Ansible.Basic.cs
test/lib/ansible_test/_data/sanity/pylint/plugins/deprecated.py
test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/main.py
test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/schema.py