Multiline support for Toolkit Annotations
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
This is a follow-up issue started at https://github.com/actions/toolkit/issues/186#issuecomment-546772099.
It is unclear from the recently added Annotation docs if ::debug/::warning/::error messages support multiline text in the {message} placeholder.
Why it is important? These Annotations can be used by various code linters and other similar tools, but their output easily could be spanned to multiple lines, for example:
pylint output:
W:108: Operator not followed by a space
print >>sys.stderr, 'Unable to match %r', line
^
Rust compiler output:
warning: comparison is useless due to type limits
--> example/src/lib.rs:20:8
|
20 | if pid < 0 {
| ^^^^^^^
|
= note: `#[warn(unused_comparisons)]` on by default
It would be nice to clarify if it is possible to use multiline strings over there and it is expected to be working correctly in the future.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked comment on issue #186 and the Annotation docs first; the issue names no source file or test. Establish whether ::debug, ::warning, and ::error accept multiline {message} values, then document the behavior or define the required support and identify how it should be verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, typescript
- Domain
- ci-cd, devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100