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

Leverage the GitHub Checks API to annotate file/line problems #2

Open
ianfixes opened this issue Jan 12, 2021 · 1 comment
Open

Leverage the GitHub Checks API to annotate file/line problems #2

ianfixes opened this issue Jan 12, 2021 · 1 comment
Assignees
Labels
type: enhancement Proposed improvement

Comments

@ianfixes
Copy link

Some (but certainly not all) lint rules pertain to a specific file and line. Other rules pertain to a file that is missing lines. By using the GitHub Checks API, this report could be surfaced in native form in a GitHub UI with appropriate links to files and/or lines in question. Additionally, the error messages could (eventually) link to rule descriptions hosted at some public URL (see arduino/arduino-lint#158)

An example of a GItHub action that creates annotations (and a summary) via the Checks API using typescript is https://github.com/Attest/annotations-action

@peternewman
Copy link
Contributor

Problem matchers are also worth considering as a far simpler/lower effort option ( https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md ), see related:
arduino/compile-sketches#27

@per1234 per1234 self-assigned this Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

3 participants