Correct code comment in the PlaybookExecutor class to reflect current behavior #83269
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
Correct a code comment in the PlaybookExecutor class that explains the host failure condition under which the PBE breaks out of the run. This comment previously stated that the maximum failure percentage was checked, but that logic has been refactored into the linear strategy plugin.
ansibot
added
bug
bcoca
approved these changes
May 21, 2024
sivel
removed
the
needs_triage
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.
SUMMARY
Correct a code comment in the PlaybookExecutor class that explains the host failure condition under which the PBE breaks out of the run. This comment previously stated that the maximum failure percentage was checked by the PHE. However, that logic has been refactored into the linear strategy plugin. The new comment reflects the actual behavior.
ISSUE TYPE
ADDITIONAL INFORMATION
This change does not make any code changes aside from comments for readability. I found this while reading the source code while working on an issue with an ansible playbook failing and trying to understand under what conditions the PlaybookExecutor would halt the run. I believe that this was an small oversight from a much earlier refactoring into strategy plugins.