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_fmt: refactor out to its own file #8964

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Oct 2, 2024

SUMMARY

Refactored the argument formatting code from the cmd_runner.py file.

The rationale behind it is:

  • unclutter the cmd_runner.py file
  • create a clear boundary between those components
  • in anticipation of writing docstrings in both files, so that the Command Runner Guide can make use of them
ISSUE TYPE
  • Refactoring Pull Request
COMPONENT NAME

plugins/module_utils/cmd_runner.py

@ansibullbot ansibullbot added module_utils module_utils plugins plugin (any type) labels Oct 2, 2024
@felixfontein felixfontein added the backport-9 Automatically create a backport for the stable-9 branch label Oct 2, 2024
@felixfontein felixfontein merged commit c4e2b73 into ansible-collections:main Oct 2, 2024
141 checks passed
Copy link

patchback bot commented Oct 2, 2024

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

❌ Failed to cleanly apply c4e2b73 on top of patchback/backports/stable-9/c4e2b731939e56a24870e9e3455381dc33ea3040/pr-8964

Backporting merged PR #8964 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-9/c4e2b731939e56a24870e9e3455381dc33ea3040/pr-8964 upstream/stable-9
  4. Now, cherry-pick PR cmd_runner_fmt: refactor out to its own file #8964 contents into that branch:
    $ git cherry-pick -x c4e2b731939e56a24870e9e3455381dc33ea3040
    If it'll yell at you with something like fatal: Commit c4e2b731939e56a24870e9e3455381dc33ea3040 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x c4e2b731939e56a24870e9e3455381dc33ea3040
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR cmd_runner_fmt: refactor out to its own file #8964 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-9/c4e2b731939e56a24870e9e3455381dc33ea3040/pr-8964
  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 again!

@felixfontein
Copy link
Collaborator

@russoz the failure to cherry-pick likely comes from the deprecation. If you want to have this change also in stable-9, you'll need to backport this manually. Otherwise this will stick to main / stable-10.

@russoz
Copy link
Collaborator Author

russoz commented Oct 2, 2024

Will take a look at it later

@russoz russoz deleted the cmd-runner-refactor-fmt-out branch October 2, 2024 19:11
russoz added a commit to russoz-ansible/community.general that referenced this pull request Oct 2, 2024
* cmd_runner_fmt: refactor out to its own file

* add new file to BOTMETA.yml

* add changelog frag

(cherry picked from commit c4e2b73)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-9 Automatically create a backport for the stable-9 branch module_utils module_utils plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants