From 03f3d696e272d8bfb041dd3c24fc3ec84b98b99d Mon Sep 17 00:00:00 2001 From: Scott Moeller Date: Fri, 12 Mar 2021 07:34:26 -0500 Subject: [PATCH 1/2] Update problem-matchers.md --- docs/problem-matchers.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/problem-matchers.md b/docs/problem-matchers.md index 50bcd1e1a8..424c92e93e 100644 --- a/docs/problem-matchers.md +++ b/docs/problem-matchers.md @@ -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: From 17cadea6fbf609b42be84878b36d4fe44eb03d8a Mon Sep 17 00:00:00 2001 From: Scott Moeller Date: Tue, 30 Mar 2021 05:43:36 -0400 Subject: [PATCH 2/2] Update docs/problem-matchers.md Fixup text Co-authored-by: Konrad Pabjan --- docs/problem-matchers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/problem-matchers.md b/docs/problem-matchers.md index 424c92e93e..e5ee0abed2 100644 --- a/docs/problem-matchers.md +++ b/docs/problem-matchers.md @@ -8,7 +8,7 @@ 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 +- 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).