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

plugins (become, callback, filter): style adjustments #9535

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Jan 6, 2025

SUMMARY

Second round of doc adjustments. Output width has been slightly reduced in andebox, and a couple of other style improvements have been added (like replacing id with ID)

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/become/pfexec.py
plugins/callback/default_without_diff.py
plugins/callback/yaml.py
plugins/filter/accumulate.py
plugins/filter/counter.py
plugins/filter/crc32.py
plugins/filter/dict.py
plugins/filter/dict_kv.py
plugins/filter/from_csv.py
plugins/filter/from_ini.py
plugins/filter/groupby_as_dict.py
plugins/filter/jc.py
plugins/filter/json_query.py
plugins/filter/keep_keys.py
plugins/filter/lists_mergeby.py
plugins/filter/random_mac.py
plugins/filter/remove_keys.py
plugins/filter/replace_keys.py
plugins/filter/reveal_ansible_type.py
plugins/filter/to_ini.py
plugins/filter/unicode_normalize.py
plugins/filter/version_sort.py

@ansibullbot ansibullbot added become become plugin callback callback plugin cloud docs filter filter plugin inventory inventory plugin plugins plugin (any type) labels Jan 6, 2025
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Jan 6, 2025
plugins/filter/remove_keys.py Outdated Show resolved Hide resolved
plugins/filter/replace_keys.py Outdated Show resolved Hide resolved
plugins/filter/reveal_ansible_type.py Outdated Show resolved Hide resolved
host: https://gitlab.com
- example 1: |
plugin: community.general.gitlab_runners
host: https://gitlab.com
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure these should be formatted this way.

Optimally one would use different YAML documents for every example, but ansible-test barfs on that.

How about not changing the inventory examples for now? I think using YAML documents is the better solution, but that's something to explore in another PR.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Removed the inventory plugins from this PR, will work with them in a separate one

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you please split up that PR in one that modifies everything but examples, and one that modifies the examples? I'd really lke to get everything but the examples done ASAP (it basically was already done in this PR, I reviewed everything but inventory examples).

@russoz russoz changed the title plugins (become, callback, filter, inventory): style adjustments plugins (become, callback, filter): style adjustments Jan 7, 2025
@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jan 7, 2025
@felixfontein felixfontein merged commit 3af793c into ansible-collections:main Jan 7, 2025
129 checks passed
Copy link

patchback bot commented Jan 7, 2025

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

❌ Failed to cleanly apply 3af793c on top of patchback/backports/stable-9/3af793c2c14679004fbceec041d551df1cc8389a/pr-9535

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

Copy link

patchback bot commented Jan 7, 2025

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/3af793c2c14679004fbceec041d551df1cc8389a/pr-9535

Backported as #9545

🤖 @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 Jan 7, 2025
* plugins (become, callback, filter, inventory): style adjustments

* remove inventory plugins from PR

* adjustments from review

* typo

(cherry picked from commit 3af793c)
@russoz russoz deleted the become-callback-filter-inventory-style branch January 7, 2025 08:11
felixfontein pushed a commit that referenced this pull request Jan 7, 2025
…lter): style adjustments (#9545)

plugins (become, callback, filter): style adjustments (#9535)

* plugins (become, callback, filter, inventory): style adjustments

* remove inventory plugins from PR

* adjustments from review

* typo

(cherry picked from commit 3af793c)

Co-authored-by: Alexei Znamensky <[email protected]>
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 backport-10 Automatically create a backport for the stable-10 branch become become plugin callback callback plugin cloud docs filter filter plugin inventory inventory plugin plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants