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

Note annotation limits in Problem Matchers documentation (#734) 

* Update problem-matchers.md

* Update docs/problem-matchers.md

Fixup text

Co-authored-by: Konrad Pabjan <konradpabjan@github.com>

Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
pull/761/head
Scott Moeller 2021-04-06 11:11:05 -04:00 committed by GitHub
parent fc00528337
commit 418978c2e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/problem-matchers.md
View File

@ -2,6 +2,16 @@
Problem Matchers are a way to scan the output of actions for a specified regex pattern and surface that information prominently in the UI. Both [GitHub Annotations](https://developer.github.com/v3/checks/runs/#annotations-object-1) and log file decorations are created when a match is detected.
## Limitations
Currently, GitHub Actions limit the annotation count in a workflow run.
- 10 warning annotations and 10 error annotations per step
- 50 annotations per job (sum of annotations from all the steps)
- 50 annotations per run (separate from the job annotations, these annotations aren’t created by users)
If your workflow may exceed these annotation counts, consider filtering of the log messages which the Problem Matcher is exposed to (e.g. by PR touched files, lines, or other).
## Single Line Matchers
Let's consider the ESLint compact output: