fix: improve missing job parameter error for summary command #44
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
Problem: The error message that one gets when using the summary command on a job template that has job parameters with no default value is a tad confusing. It looks like: ``` ERROR generating Job: Parameters can't be used with Template: Values missing for required job parameters: NumAnimationFrames, OutputDirectory, RenderScript ``` The "Parameters can't be used with Template" part is leading to confusion. Solution: Remove the problematic phase from the error. The error comes from trying to preprocess_job_parameters(), and that function already has decent error messaging. Signed-off-by: Daniel Neilson <[email protected]>
AWS-Samuel
approved these changes
Feb 12, 2024
epmog
approved these changes
Feb 12, 2024
marofke
approved these changes
Feb 12, 2024
Merged
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.
What was the problem/requirement? (What/Why)
The error message that one gets when using the summary command on a job template that has job parameters with no default value is a tad confusing. It looks like:
The "Parameters can't be used with Template" part is leading to confusion.
What was the solution? (How)
Remove the problematic phase from the error. The error comes from trying to preprocess_job_parameters(), and that function already has decent error messaging.
What is the impact of this change?
An error message that is more actionable.
How was this change tested?
Just running the
openjd summarycommand locally.Was this change documented?
N/A
Is this a breaking change?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.