Leverage the GitHub Checks API to annotate file/line problems
ianfixes opened this issue · 1 comments
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
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