Skip to content

Commit 418978c

Browse files
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>
1 parent fc00528 commit 418978c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/problem-matchers.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
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.
44

5+
## Limitations
6+
7+
Currently, GitHub Actions limit the annotation count in a workflow run.
8+
9+
- 10 warning annotations and 10 error annotations per step
10+
- 50 annotations per job (sum of annotations from all the steps)
11+
- 50 annotations per run (separate from the job annotations, these annotations aren’t created by users)
12+
13+
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).
14+
515
## Single Line Matchers
616

717
Let's consider the ESLint compact output:

0 commit comments

Comments
 (0)