Add toggle for verbose logging to pkg5.py #8382
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated params with 'verbose' mode (defaults to False, which is existing behavior) to allow users to toggle verbose to True, which disables the '-q' flag that was hardcoded in the original module
ansibullbot
added
feature
This comment was marked as outdated.
This comment was marked as outdated.
ansibullbot
added
ci_verified
The new verbosity argument on line 172 broke the 160 character length PEP8 requirement - split the line in two to conform to PEP8
ansibullbot
removed
ci_verified
felixfontein
added
the
check-before-release
plugins/modules/pkg5.py
Outdated
| @@ -54,6 +54,11 @@ | |||
| - Refresh publishers before execution. | |||
| type: bool | |||
| default: true | |||
| verbose: | |||
| description: | |||
| - Toggles quiet execution on or off | |||
There was a problem hiding this comment.
I personally find the following clearer to understand:
Suggested change
| - Toggles quiet execution on or off | |
| - Set to V(true) to disable quiet execution. |
Co-authored-by: Felix Fontein <felix@fontein.de>
…n for semantic markup Co-authored-by: Felix Fontein <felix@fontein.de>
felixfontein
removed
the
check-before-release
|
@Klistel thanks for your contribution! |
austinlucaslake
pushed a commit
to austinlucaslake/community.general
that referenced
this pull request
May 25, 2024
* Add toggle for verbose logging Updated params with 'verbose' mode (defaults to False, which is existing behavior) to allow users to toggle verbose to True, which disables the '-q' flag that was hardcoded in the original module * Create 8379-verbose-mode-pkg5.yml * update pkg5.py to conform to PEP8 length requirements The new verbosity argument on line 172 broke the 160 character length PEP8 requirement - split the line in two to conform to PEP8 * Add PR link to changelog fragement yml Co-authored-by: Felix Fontein <felix@fontein.de> * Add version_added and make the description of the verbose param clearer * Update pkg5.py verbose description to conform to ansible documentation for semantic markup Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated params for community.general.pkg5 with 'verbose' mode (defaults to False, which is existing silent execution behavior) to allow users to toggle verbose to True, which disables the '-q' flag that was hardcoded in the original module
SUMMARY
Fixes: #8379
Add a simple boolean to enable the user of the pkg5 module to enable verbose mode, which removes the previously hardcoded -q flag from the command string.
ISSUE TYPE
COMPONENT NAME
pkg5
ADDITIONAL INFORMATION
The existing module.run_command included the arguments -q hardcoded. I added a user-driven boolean that removes the '-q' if the user sets the flag to true