Skip to content

Clarify annotations behavior #1202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks done
kema-dev opened this issue Mar 18, 2025 · 0 comments · Fixed by #1203
Closed
2 tasks done

Clarify annotations behavior #1202

kema-dev opened this issue Mar 18, 2025 · 0 comments · Fixed by #1203
Labels
area: annotations documentation Improvements or additions to documentation

Comments

@kema-dev
Copy link
Contributor

Welcome

  • Yes, I understand that the GitHub action repository is not the repository of golangci-lint itself.
  • Yes, I've searched similar issues on GitHub and didn't find any.

Your feature request related to a problem? Please describe.

The readme here suggests that checks: write permissions are needed for annotation to work. I do not think this is true.
As this line suggests, annotation are made from problem matchers, as documented here.
As far as I could test, such annotation-from-logs does not need permissions to show in PR changed files.
The checks / problem matchers / annotation on GitHub looks kinda misleading to me, let me know if I missed something

Describe the solution you'd like.

Remove the checks: write mention in the readme

Describe alternatives you've considered.

#5, but needs some more code

Additional context.

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: annotations documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants