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

Remove custom output callback plugin #1418

Merged
merged 1 commit into from
Aug 9, 2022

Conversation

swalkinshaw
Copy link
Member

@swalkinshaw swalkinshaw commented Aug 8, 2022

This custom output plugin had three main functions:

  1. make the output for dictionaries cleaner (print key only)
  2. display system info on failure for debugging purposes
  3. couple other minor cosmetic changes

The commit 5d5d1d2 already improved all the dict output by explicitly specifying a loop label which should always be used when needed from now on. This removes the need for modifying dict output at this callback level.

While the system info can be helpful for troubleshooting, the most important parts of that information can be returned by running Ansibles' verbose mode (-vv). There's been many cases in the past of this information being confusing or misleading as well.

While this custom output probably provides a small benefit, removing custom code like this makes it easier to maintain Trellis over the long term since Ansible provides less compatibility for these APIs.

https://docs.roots.io/trellis/master/troubleshooting/#debugging might need some minor updating as well.

@swalkinshaw swalkinshaw force-pushed the remove-custom-output-callback branch from 52f7375 to f5f6f12 Compare August 8, 2022 18:24
This custom output plugin had three main functions:

1. make the output for dictionaries cleaner (print key only)
2. display system info on failure for debugging purposes
3. couple other minor cosmetic changes

The commit 5d5d1d2 already improved all
the dict output by explicitly specifying a `label` which should always
be used when needed from now on. This removes the need for modifying
dict output at this callback level.

While the system info can be helpful for troubleshooting, the most
important parts of that information can be returned by running Ansibles'
verbose mode (`-vv`). There's been many cases in the past of this
information being confusing or misleading as well.

While this custom output probably provides a small benefit, removing
custom code like this makes it easier to maintain Trellis over the long
term since Ansible provides less compatibility for these APIs.
@swalkinshaw swalkinshaw force-pushed the remove-custom-output-callback branch from f5f6f12 to 9d630c8 Compare August 8, 2022 18:27
@swalkinshaw swalkinshaw merged commit 8b9b973 into master Aug 9, 2022
@swalkinshaw swalkinshaw deleted the remove-custom-output-callback branch August 9, 2022 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant