github/actions: fix annotation title handling #18283
Merged
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
We currently generate invalid workflow commands when we create annotations with a `title` but no `file`. Let's fix that. While we're here, let's improve handling of `title`s with `:`s. We cannot use `title`s with `::` since GitHub Actions uses this as a separator for different fields between a workflow command. Let's also make sure `metadata` never ends in a `:` to avoid confusing the GitHub Actions command parser about where the `::` separator is meant to be.
Bo98
approved these changes
Sep 9, 2024
| @@ -110,7 +111,11 @@ def to_s | |||
| end | |||
| end | |||
|
|
|||
| metadata << ",title=#{Actions.escape(@title)}" if @title | |||
| if @title | |||
| metadata << (@file ? "," : " ") | |||
There was a problem hiding this comment.
This should probably go into an array which we join(",")
|
Thanks @carlocab! |
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.
brew stylewith your changes locally?brew typecheckwith your changes locally?brew testswith your changes locally?We currently generate invalid workflow commands when we create
annotations with a
titlebut nofile. Let's fix that.While we're here, let's improve handling of
titles with:s. Wecannot use
titles with::since GitHub Actions uses this as aseparator for different fields between a workflow command.
Let's also make sure
metadatanever ends in a:to avoid confusingthe GitHub Actions command parser about where the
::separator ismeant to be.