@actions/core logging - extract AnnotationProperties from Error instances
#1696
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
…with error/warning/notice
…o honor an empty object passed in
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.
Background
While improving a logging situation in
actions/configure-pages, I had the idea that it might be nice if the@actions/coremodule'serror,warning, andnoticecommands would implicitly extract their optionalAnnotationPropertiesmetadata parameter from the stack traces of the sometimes-providedErrorinstance parameter. 💡This PR is my rough cut at what that might look like. 💝
Totally open to revisions, refactoring, etc. 👂🏻
Edit: I updated the behavior for defaulting the
propertiesparameter such that I think this could probably be considered a non-breaking change. 🤞🏻ℹ️ Clarification after chatting with @joshmgross a bit: this behavior will create an annotation for whatever action/step is utilizing the
@actions/coremodule for logging. That may or may not align with the intended use of annotations, which commonly point to files that are present within the consuming repository. That said, it does still successfully display an annotation in the workflow summary (although the link it generates won't match any target if the file isn't in the repo):