Add comment to workflow re: unexpected behavior of "liskin/gh-problem-matcher-wrap" action #656
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
…-matcher-wrap" action The "liskin/gh-problem-matcher-wrap" action is used in the "Check Shell" workflow to enhance the workflow run results summary by applying a "problem matcher" to the output of the shellcheck tool. This action is a wrapper around shell commands, so we would expect its `run` input to work the same as the `jobs.<job_id>.steps[*].run` key of the GitHub Actions workflow. However, this is not the case. The commands specified via the `jobs.<job_id>.steps[*].run` key can be split into multiple lines using the standard shell line continuation operator. That is useful in the case of long/complex shell commands such as the one used to execute the `shell:check` task in this workflow step. This is not possible when using "liskin/gh-problem-matcher-wrap". A comment is added to explain this behavior.
per1234
added
topic: documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The "liskin/gh-problem-matcher-wrap" action is used in the "Check Shell" workflow to enhance the workflow run results summary by applying a "problem matcher" to the output of the shellcheck tool.
This action is a wrapper around shell commands, so we would expect its
runinput to work the same as thejobs.<job_id>.steps[*].runkey of the GitHub Actions workflow. However, this is not the case. The commands specified via thejobs.<job_id>.steps[*].runkey can be split into multiple lines using the standard shell line continuation operator. That is useful in the case of long/complex shell commands such as the one used to execute theshell:checktask in this workflow step. This is not possible when using "liskin/gh-problem-matcher-wrap".A comment is added to explain this behavior.