Skip to content

yaml callback plugin: deprecation #9456

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

Jump to bottom
Merged
merged 4 commits into from
Dec 29, 2024
Merged

yaml callback plugin: deprecation #9456

merged 4 commits into from
Dec 29, 2024

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Dec 29, 2024

SUMMARY

The plugin itself has a note stating that since ansible-core 2.13 (as of Dec '24 the minimum verison of ansible-core supported by community.general) has the functionality implemented within its default callback plugin.

ISSUE TYPE
  • Feature Pull Request
COMPONENT NAME

plugins/callback/yaml.py

@ansibullbot ansibullbot added callback callback plugin feature This issue/PR relates to a feature request needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR plugins plugin (any type) and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Dec 29, 2024
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-10 Automatically create a backport for the stable-10 branch labels Dec 29, 2024
felixfontein
felixfontein reviewed Dec 29, 2024
View reviewed changes
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

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

Since yaml is (or at least used to be, not sure how many migrated to result_format=yaml) one of the most used callback plugins, it might be warranted to have a longer deprecation period. What do you think of only removing it from 13.0.0, so users have a bit more than a full year to adjust?

@russoz
Copy link
Collaborator Author

russoz commented Dec 29, 2024

Since yaml is (or at least used to be, not sure how many migrated to result_format=yaml) one of the most used callback plugins, it might be warranted to have a longer deprecation period. What do you think of only removing it from 13.0.0, so users have a bit more than a full year to adjust?

agreed!

@ansibullbot ansibullbot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Dec 29, 2024
@felixfontein
Copy link
Collaborator

@russoz it looks like this now has conflicts as well...

@felixfontein felixfontein changed the title yaml callback pulign: deprecation yaml callback plugin: deprecation Dec 29, 2024
@russoz russoz force-pushed the deprecate-yaml-callback branch from 95ca5af to 52003cc Compare December 29, 2024 20:01
@ansibullbot ansibullbot removed the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Dec 29, 2024
@felixfontein felixfontein merged commit 17d36da into ansible-collections:main Dec 29, 2024
129 checks passed
@patchback Patchback
Copy link

patchback bot commented Dec 29, 2024 •
edited
Loading

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

❌ Failed to cleanly apply 17d36da on top of patchback/backports/stable-10/17d36da15049b3c8cef455db27f132d51b3ac212/pr-9456

Backporting merged PR #9456 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-10/17d36da15049b3c8cef455db27f132d51b3ac212/pr-9456 upstream/stable-10
  4. Now, cherry-pick PR yaml callback plugin: deprecation #9456 contents into that branch: 
    $ git cherry-pick -x 17d36da15049b3c8cef455db27f132d51b3ac212
    If it'll yell at you with something like fatal: Commit 17d36da15049b3c8cef455db27f132d51b3ac212 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x 17d36da15049b3c8cef455db27f132d51b3ac212
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR yaml callback plugin: deprecation #9456 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-10/17d36da15049b3c8cef455db27f132d51b3ac212/pr-9456
  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 felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Dec 29, 2024
@felixfontein
Copy link
Collaborator

@russoz thanks for your contribution!

@felixfontein felixfontein added backport-10 Automatically create a backport for the stable-10 branch and removed backport-10 Automatically create a backport for the stable-10 branch labels Dec 29, 2024
@patchback Patchback
Copy link

patchback bot commented Dec 29, 2024 •
edited
Loading

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/17d36da15049b3c8cef455db27f132d51b3ac212/pr-9456

Backported as #9469

🤖 @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 Dec 29, 2024
@russoz @patchback
yaml callback plugin: deprecation (#9456)
c0823fc 
* yaml callback pulign: deprecation

* add changelog frag

* Update plugins/callback/yaml.py

Co-authored-by: Felix Fontein <[email protected]>

* set removal to 13.0.0

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 17d36da)
@patchback patchback bot mentioned this pull request Dec 29, 2024
Merged
felixfontein pushed a commit that referenced this pull request Dec 29, 2024
@patchback @russoz
[PR #9456/17d36da1 backport][stable-10] yaml callback plugin: depreca…
a68de9b 
…tion (#9469)

yaml callback plugin: deprecation (#9456)

* yaml callback pulign: deprecation

* add changelog frag

* Update plugins/callback/yaml.py

Co-authored-by: Felix Fontein <[email protected]>

* set removal to 13.0.0

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 17d36da)

Co-authored-by: Alexei Znamensky <[email protected]>
@russoz russoz deleted the deprecate-yaml-callback branch December 29, 2024 22:35
Massl123 pushed a commit to Massl123/community.general that referenced this pull request Feb 7, 2025
@russoz @felixfontein @Massl123
yaml callback plugin: deprecation (ansible-collections#9456)
cd39a06 
* yaml callback pulign: deprecation

* add changelog frag

* Update plugins/callback/yaml.py

Co-authored-by: Felix Fontein <[email protected]>

* set removal to 13.0.0

---------

Co-authored-by: Felix Fontein <[email protected]>
austinlucaslake pushed a commit to austinlucaslake/community.general that referenced this pull request Mar 14, 2025
@russoz @felixfontein @austinlucaslake
yaml callback plugin: deprecation (ansible-collections#9456)
c2b7b38 
* yaml callback pulign: deprecation

* add changelog frag

* Update plugins/callback/yaml.py

Co-authored-by: Felix Fontein <[email protected]>

* set removal to 13.0.0

---------

Co-authored-by: Felix Fontein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixfontein felixfontein felixfontein approved these changes

Assignees
No one assigned
Labels
backport-10 Automatically create a backport for the stable-10 branch callback callback plugin feature This issue/PR relates to a feature request 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@russoz @felixfontein @ansibullbot