Skip to content

Commit d073fb8

Browse files
authored
doc: add information about annotation limitations
1 parent 9d1e062 commit d073fb8

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ You will also likely need to add the following `.gitattributes` file to ensure t
154154
*.go text eol=lf
155155
```
156156

157-
## Comments and Annotations
157+
## Annotations
158158

159159
Currently, GitHub parses the action's output and creates [annotations](https://github.blog/2018-12-14-introducing-check-runs-and-annotations/).
160160

@@ -163,6 +163,7 @@ The restrictions of annotations are the following:
163163
1. Currently, they don't support Markdown formatting (see the [feature request](https://i.8713187.xyzmunity/t5/GitHub-API-Development-and/Checks-Ability-to-include-Markdown-in-line-annotations/m-p/56704))
164164
2. They aren't shown in the list of comments.
165165
If you would like to have comments - please, up-vote [the issue](https://github.com/golangci/golangci-lint-action/issues/5).
166+
3. The number of annotations is [limited](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md#limitations).
166167

167168
To enable annotations, you need to add the `checks' permission to your action.
168169

0 commit comments

Comments
 (0)