Skip to content
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

GitHub Annotation Limits ( 10 Errors, 10 Warnings) #226

Open
aniaq opened this issue Dec 24, 2024 · 2 comments
Open

GitHub Annotation Limits ( 10 Errors, 10 Warnings) #226

aniaq opened this issue Dec 24, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@aniaq
Copy link

aniaq commented Dec 24, 2024

The GitHub annotations system enforces a hard limit of 10 errors/warnings per check run, which can create challenges when running comprehensive checks with a higher number of warnings. This limitation can hinder effective debugging and reviewing for larger projects.

When running the plugin-check-action, only the first 10 errors/ warnings are displayed as annotations. This might lead to missing other important errors/warnings unless users manually check the logs or artifacts for detailed output.

Possible workarounds:

  1. Combine multiple errors/warnings into a single annotation message to stay within the 10 error /warning limit while still providing meaningful feedback.
  2. Produce an artifact (e.g., HTML or JSON file) containing a full report of all errors / warnings. Users can download this file for in-depth analysis.

Would it make sense to implement one of these workarounds in this action?

Reference: Extremely low annotation limit Thank you for considering this improvement!

@swissspidy swissspidy added the enhancement New feature or request label Dec 24, 2024
@swissspidy
Copy link
Member

swissspidy commented Dec 24, 2024

Thanks for opening this.

When introducing Plugin Check in larger projects it's probably best to start with the plugin and not the GitHub Action, because of the much faster feedback loop. Later on you’ll automatically have fewer annotations. So I'd consider this a bit of an edge case.

As for potential solutions, I think leaving a PR comment is probably best, see #1

Grouping unrelated messages in an unrelated file sounds weird from a UX perspective. An artifact might be a nice addition, but is also easy to miss. If you need a table with all errors, the plugin is the quicker choice.

@aniaq
Copy link
Author

aniaq commented Jan 26, 2025

We are encountering challenges due to a high number of false positives in our project, making it difficult to review all warnings within a single GitHub Action run. In addition to the time required for multiple workflow runs, the annotation limits are consuming GitHub resources.

Instead of increasing these limits, it would be highly beneficial if the file paths and line numbers were displayed directly in the logs. This would allow us to quickly identify and address issues without relying solely on GitHub annotations.

Would it be possible to modify the output format in the action logs to include file paths and line numbers?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants