Toolkit Annotation support
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
The toolkit should support first class support for adding annotations
export function addAnnotation(annotation: Annotation): void
Annotation object will match this
Annotation level will be a toolkit enum which gets written as a string to the annotation. We need to add Notice to the timeline issue
export enum AnnotationLevel {
Notice = 0,
Warning = 1,
Failure=2
}
the equivalent cmd will accept properties that match the annotation properties
echo ::add-annotation annotation_level=error, path=css/main.css, start_line=0, end_line=0::myMessage
toolkit error and warning will emit [error]message and [warning]message which the UI will decorate red or yellow. (error and warning does not currently support an annotation). The web UI should colorize but string the [error] and [warning] from the view (but still in the logs)
The existing logging error and warning command will emit [error]message and [warning]message. Even though not documented, they take properties (problem matchers). If those properties are used, then for compat, create an issue object which will become an annotation service side.
After this is complete, change problem matchers to use the add-annotation cmd or toolkit methods.
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.
Assessment
This issue has not been assessed yet.