Skip to content

Commit

Permalink
doc: add information about annotation limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
ldez committed May 1, 2024
1 parent 9d1e062 commit d073fb8
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -154,7 +154,7 @@ You will also likely need to add the following `.gitattributes` file to ensure t
*.go text eol=lf
```

## Comments and Annotations
## Annotations

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

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

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

Expand Down

0 comments on commit d073fb8

Please sign in to comment.