Improve GitHub Action failure reporting annotation #821
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
[GitHub parses console output for special phrases](https://stackoverflow.com/a/71091060) to better format it's output. By doing this when we report errors, we can more clearly communicate errors: Compare [before](https://github.com/JackPGreen/rel-scripts/actions/runs/11711717220): Against [after](https://github.com/JackPGreen/rel-scripts/actions/runs/11711863956):
ldziedziul
approved these changes
Nov 7, 2024
nishaatr
approved these changes
Nov 11, 2024
JackPGreen
added a commit
that referenced
this pull request
Nov 15, 2024
The action [failed](https://github.com/hazelcast/hazelcast-docker/actions/runs/11831672090/attempts/1) but without providing enough information to understand _why_. Changes: - Log the `get_image` function response (JSON) in case of failure - Improve failure annotation reporting (as per #821) - Address all Shellcheck warnings in case related - [Declare and assign separately to avoid masking return values](https://www.shellcheck.net/wiki/SC2155) - [Prefer putting braces around variable references even when not strictly required](https://www.shellcheck.net/wiki/SC2250) - [Quote the rhs of = in [[ ]] to prevent glob matchingQuote the rhs of = in [[ ]] to prevent glob matching](https://www.shellcheck.net/wiki/SC2053) _Partially addresses_ [DI-342](https://hazelcast.atlassian.net/browse/DI-342) Post-merge actions: - [ ] backport
1 task
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.
GitHub parses console output for special phrases to better format it's output. By doing this when we report errors, we can more clearly communicate errors:
Compare before:
Against after:
