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

cmd_runner: deprecate fmt as the name for the format class #4777

Merged

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Jun 4, 2022

SUMMARY

Deprecate fmt in favour of cmd_runner_fmt as the name of the object to be imported for formatting parameters.

ISSUE TYPE
  • Feature Pull Request
COMPONENT NAME

plugins/module_utils/cmd_runner.py
plugins/module_utils/gconftool2.py

@ansibullbot ansibullbot added feature This issue/PR relates to a feature request integration tests/integration module_utils module_utils plugins plugin (any type) tests tests labels Jun 4, 2022
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-5 labels Jun 5, 2022
@felixfontein felixfontein merged commit 2d38c8d into ansible-collections:main Jun 5, 2022
@patchback
Copy link

patchback bot commented Jun 5, 2022

Backport to stable-5: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 2d38c8d on top of patchback/backports/stable-5/2d38c8d892acd69ae71024fad3c99aecb68c8220/pr-4777

Backporting merged PR #4777 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible-collections/community.general.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-5/2d38c8d892acd69ae71024fad3c99aecb68c8220/pr-4777 upstream/stable-5
  4. Now, cherry-pick PR cmd_runner: deprecate fmt as the name for the format class #4777 contents into that branch:
    $ git cherry-pick -x 2d38c8d892acd69ae71024fad3c99aecb68c8220
    If it'll yell at you with something like fatal: Commit 2d38c8d892acd69ae71024fad3c99aecb68c8220 is a merge but no -m option was given., add -m 1 as follows intead:
    $ git cherry-pick -m1 -x 2d38c8d892acd69ae71024fad3c99aecb68c8220
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR cmd_runner: deprecate fmt as the name for the format class #4777 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-5/2d38c8d892acd69ae71024fad3c99aecb68c8220/pr-4777
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

@felixfontein
Copy link
Collaborator

@russoz thanks for improving the module utils :)

@felixfontein
Copy link
Collaborator

Hmm, looks like I have to merge some backports first before this can be backported. In that case I'll add the backport label again once I got these merged (which will be after 5.0.2 has been released somewhen tomorrow).

@russoz russoz deleted the cmd-runner-fmt branch June 5, 2022 20:35
@felixfontein felixfontein added backport-5 and removed check-before-release PR will be looked at again shortly before release and merged if possible. labels Jun 5, 2022
@patchback
Copy link

patchback bot commented Jun 6, 2022

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/2d38c8d892acd69ae71024fad3c99aecb68c8220/pr-4777

Backported as #4784

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

patchback bot pushed a commit that referenced this pull request Jun 6, 2022
* cmd_runner: deprecate fmt as the name for the format class

* added changelog fragment

* fixing the deprecation comment

(cherry picked from commit 2d38c8d)
felixfontein pushed a commit that referenced this pull request Jun 6, 2022
…4784)

* cmd_runner: deprecate fmt as the name for the format class

* added changelog fragment

* fixing the deprecation comment

(cherry picked from commit 2d38c8d)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
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 integration tests/integration module_utils module_utils plugins plugin (any type) tests tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants