actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

docs(core): add how to provide annotation properties

pull/1961/head
Emilien Escalle 2025-02-19 16:19:46 +01:00 committed by GitHub
parent 2b08dc18f2
commit aa6719ed20
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
packages/core/README.md
View File

@ -170,6 +170,22 @@ export interface AnnotationProperties {
} }
``` ```
Example:
```js
core.error(
'This is a bad error seen in file.',
{
title: "Unexecpted Error",
file: "path/to/errored-file.js",
startLine: 1,
endLine: 2,
startColumn: 1,
endColumn: 10,
}
)
```
#### Styling output #### Styling output
Colored output is supported in the Action logs via standard [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code). 3/4 bit, 8 bit and 24 bit colors are all supported. Colored output is supported in the Action logs via standard [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code). 3/4 bit, 8 bit and 24 bit colors are all supported.
@ -483,4 +499,4 @@ core.summary.emptyBuffer()
// Writes text in the buffer to the summary buffer file and empties the buffer, optionally overwriting all existing content in the summary file with buffer contents. Defaults to false. // Writes text in the buffer to the summary buffer file and empties the buffer, optionally overwriting all existing content in the summary file with buffer contents. Defaults to false.
core.summary.write({overwrite: true}) core.summary.write({overwrite: true})
``` ```