You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-1Lines changed: 13 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -144,13 +144,25 @@ You will also likely need to add the following `.gitattributes` file to ensure t
144
144
145
145
## Comments and Annotations
146
146
147
-
Currently, GitHub parses the action's output and creates [annotations](https://github.community/t5/GitHub-Actions/What-are-annotations/td-p/30770).
147
+
Currently, GitHub parses the action's output and creates [annotations](https://github.blog/2018-12-14-introducing-check-runs-and-annotations/).
148
148
149
149
The restrictions of annotations are the following:
150
150
151
151
1. Currently, they don't support markdown formatting (see the [feature request](https://gh.loli.gardenmunity/t5/GitHub-API-Development-and/Checks-Ability-to-include-Markdown-in-line-annotations/m-p/56704))
152
152
2. They aren't shown in the list of comments like it was with [golangci.com](https://golangci.com). If you would like to have comments - please, up-vote [the issue](https://github.com/golangci/golangci-lint-action/issues/5).
153
153
154
+
To enable annotations, you need to add the `checks' permission to your action.
155
+
156
+
```yaml annotate
157
+
permissions:
158
+
# Required: allow read access to the content for analysis.
159
+
contents: read
160
+
# Optional: allow read access to pull request. Use with `only-new-issues` option.
161
+
pull-requests: read
162
+
# Optional: Allow write access to checks to allow the action to annotate code in the PR.
163
+
checks: write
164
+
```
165
+
154
166
## Performance
155
167
156
168
The action was implemented with performance in mind:
0 commit comments