fix: improve error message for unsupported manifest versions #51
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
Signed-off-by: Gahyun Suh <[email protected]>
gahyusuh
force-pushed
the
gahyusuh/err_msg_manifest_version
branch
from
d0fa0dd to
0c2c354
Compare
marofke
approved these changes
Sep 22, 2023
agerveshi
approved these changes
Sep 22, 2023
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)
When Job Attachments library tries to decode a manifest but gets an unsupported manifest version, the current error message does not provide clear info about what the actual supported versions are.
What was the solution? (How)
We need to make the error messages very clear. Improved the error message to include a list of currently supported versions.
What is the impact of this change?
Makes the error message more informative, aiding in quicker issue resolution.
How was this change tested?
hatch run lint && hatch run testhatch run integ:testWas this change documented?
No.
Is this a breaking change?
No.