invocable: Do not print help message on error. #1002
Merged
Conversation
This file contains hidden or 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
The help message is extremely large for our invocables, and tends to cause the terminal to scroll up, which ultimately causes the actual error message to be lost in the noise. Instead, lets continue to print the error message, but only add a note that the user can use `--help` to print the help message if they wish.
apop5
approved these changes
Jul 2, 2025
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1002 +/- ##
==========================================
+ Coverage 78.75% 79.63% +0.88%
==========================================
Files 49 44 -5
Lines 4909 6247 +1338
==========================================
+ Hits 3866 4975 +1109
- Misses 1043 1272 +229
🚀 New features to boost your workflow:
|
makubacki
approved these changes
Jul 2, 2025
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.
When an error occurs with loading the platform configuration file, an error message is printed, and then the help message. The help message is extremely large for our invocable, and tends to cause the terminal to scroll up, which ultimately causes the actual error message to be lost in the noise.
Instead, lets continue to print the error message, but only add a note that the user can use
--helpto print the help message if they wish.