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

MH CmdModuleHelper: deprecation #5370

Merged

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Oct 15, 2022

SUMMARY

Since the introduction of CmdRunner in April 2022, it should be preferred to CmdMixin and the derived classes CmdModuleHelper and CmdStateModuleHelper.

This PR deprecates CmdMixin.

ISSUE TYPE
  • Feature Pull Request
COMPONENT NAME

plugins/module_utils/mh/mixins/cmd.py

@ansibullbot ansibullbot added feature This issue/PR relates to a feature request module_utils module_utils plugins plugin (any type) labels Oct 15, 2022
@ansibullbot ansibullbot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Oct 15, 2022
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-5 labels Oct 15, 2022
self.module.deprecate(
'The CmdMixin used in classes CmdModuleHelper and CmdStateModuleHelper is being deprecated. '
'Modules should use community.general.plugins.module_utils.cmd_runner.CmdRunner instead.',
version='8.0.0',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case it turns out someone from outside this collection is relying on it, we should bump this up to 9.0.0. But as long as nobody is complaining, let's keep 8.0.0 :)

@felixfontein
Copy link
Collaborator

The remaining CI failures are unrelated.

@felixfontein felixfontein merged commit 91cac4c into ansible-collections:main Oct 23, 2022
@patchback
Copy link

patchback bot commented Oct 23, 2022

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/91cac4c8165b29d590482e2d39522fc2e1630d9d/pr-5370

Backported as #5413

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Oct 23, 2022
patchback bot pushed a commit that referenced this pull request Oct 23, 2022
* MH CmdModuleHelper: deprecation

* add changelog fragment

* add deprecation comments in many parts of the code

(cherry picked from commit 91cac4c)
@felixfontein
Copy link
Collaborator

@russoz thanks!

@github-actions
Copy link

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

felixfontein pushed a commit that referenced this pull request Oct 23, 2022
* MH CmdModuleHelper: deprecation

* add changelog fragment

* add deprecation comments in many parts of the code

(cherry picked from commit 91cac4c)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
@russoz russoz deleted the mh-cmd-mixin-deprecation branch October 23, 2022 20:29
russoz added a commit to russoz-ansible/community.general that referenced this pull request Nov 5, 2022
* MH CmdModuleHelper: deprecation

* add changelog fragment

* add deprecation comments in many parts of the code
bratwurzt pushed a commit to bratwurzt/community.general that referenced this pull request Nov 7, 2022
* MH CmdModuleHelper: deprecation

* add changelog fragment

* add deprecation comments in many parts of the code
bratwurzt pushed a commit to bratwurzt/community.general that referenced this pull request Nov 7, 2022
* MH CmdModuleHelper: deprecation

* add changelog fragment

* add deprecation comments in many parts of the code
This was referenced Nov 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This issue/PR relates to a feature request module_utils module_utils needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants