Tools: Recommend what to do when astyle fails #28557
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
peterbarker
requested changes
Nov 8, 2024
Tools/scripts/run_astyle.py
Outdated
| @@ -60,7 +60,7 @@ def check(self): | |||
| self.progress("astyle check failed: (%s)" % (ret.stdout)) | |||
| self.retcode = 1 | |||
| if "Formatted" in ret.stdout: | |||
| self.progress("Files needing formatting found") | |||
| self.progress("Files needing formatting found. Please run ./Tools/scripts/run_astyle.py") | |||
There was a problem hiding this comment.
This is a really strange thing to be printing in run_astyle.py!
If this is intended to make CI clearer, grepping the output of the dry-run might be a better idea.
There was a problem hiding this comment.
Is your expectation that we only print this in build_ci.sh? I don't see why we need to grep when we can just check the return code.
There was a problem hiding this comment.
Yes, that's my expectation - don't confuse the user who is running this manually.
There was a problem hiding this comment.
Please look again. I've moved this message to build-ci.sh and check the error code.
Signed-off-by: Ryan Friedman <[email protected]>
Signed-off-by: Ryan Friedman <[email protected]>
Ryanf55
force-pushed
the
astyle-recommend-resolution-after-failure
branch
from
30e2750
to
bb56e9c
Compare
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.
Purpose
Tell developers what to do if the astyle check fails.
Motivation
ArduPilot/ardupilot_wiki#6292 (comment)
Demo
This is what a developer will see if they push code and CI fails.
Specifically, we went from:
to:
In the screenshot below, I intentionally broke formatting in AP_DDS_Client.h. This is what the script will display in CI.
