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.

Sign up for GitHub

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

opkg: deprecate value "" for force #9172

Merged
merged 4 commits into from
Dec 2, 2024
Merged

opkg: deprecate value "" for force #9172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d0cb5f2
opkg: deprecate value "" for force
russoz Nov 22, 2024
5be2cc8
fix sanity plus wording
russoz Nov 22, 2024
b7ec58f
add comments for future removal
russoz Nov 22, 2024
d1f19a3
add changelog frag
russoz Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/9172-opkg-deprecate-force-none.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
deprecated_features:
- opkg - deprecate value ``""`` for parameter ``force`` (https://github.com/ansible-collections/community.general/pull/9172).
9 changes: 6 additions & 3 deletions plugins/modules/opkg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@
force:
description:
- The C(opkg --force) parameter used.
- Passing V("") as value and not passing any value at all have both
the same effect of B(not) using any C(--force-) parameter.
- State V("") is deprecated and will be removed in community.general 12.0.0. Please omit the parameter O(force) to obtain the same behavior.
choices:
- ""
- "depends"
Expand Down Expand Up @@ -152,7 +151,11 @@ def __init_module__(self):
)

def _force(value):
# 12.0.0 function _force() to be removed entirely
if value == "":
self.deprecate('Value "" is deprecated. Simply omit the parameter "force" to prevent any --force-X argument when running opkg',
version="12.0.0",
collection_name="community.general")
value = None
return cmd_runner_fmt.as_optval("--force-")(value, ctx_ignore_none=True)

Expand All @@ -164,7 +167,7 @@ def _force(value):
arg_formats=dict(
package=cmd_runner_fmt.as_list(),
state=cmd_runner_fmt.as_map(state_map),
force=cmd_runner_fmt.as_func(_force),
force=cmd_runner_fmt.as_func(_force), # 12.0.0 replace with cmd_runner_fmt.as_optval("--force-")
update_cache=cmd_runner_fmt.as_bool("update"),
version=cmd_runner_fmt.as_fixed("--version"),
),
Expand Down