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

[Enhancement] Support the GitHub Checks API #294

Open
zhuravel opened this issue May 10, 2018 · 9 comments
Open

[Enhancement] Support the GitHub Checks API #294

zhuravel opened this issue May 10, 2018 · 9 comments
Labels
enhancement help wanted Get involved! We'd love to have your help.

Comments

@zhuravel
Copy link

zhuravel commented May 10, 2018

Learn more about Checks:
https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/
https://help.github.com/articles/about-status-checks/#checks
https://developer.github.com/v3/checks/

checks_annotation

@mknapik
Copy link
Contributor

mknapik commented May 15, 2018

IMO looks very promising! I only wonder if we should wait until it leaves the beta or assume the API won't change that much and jump into implementation.

@kevinjalbert
Copy link
Contributor

Looks like its also only for GitHub Apps at this point.

The Checks API is only available to GitHub Apps through a new granular permission: checks.

Correct me if I'm wrong, but pronto still runs using an Access Token? Thus not really qualified as a GitHub App.

@aergonaut
Copy link
Member

If there were a Checks API formatter, then that could use App credentials instead of Access Tokens. I would not see Checks API replacing the existing GitHub-oriented formatters, just providing an alternative.

@aergonaut
Copy link
Member

This also makes me think we should make the formatters pluggable like the runners are. That way the community could provide a Checks API formatter without needing to have it merged to the main gem.

@blackjid
Copy link

https://github.com/haya14busa/reviewdog is a similar project that has checks API support. They have a server that receives the comments from the linter and the server communicates with the githubs Checks API.

Maybe this is a good approach. A simple server that anyone can run in a small heroku instance.

@jbielick
Copy link

jbielick commented Oct 8, 2019

Pluggable formatters is a really good idea.

In lieu of that, we set up a GitHub Action to run Pronto (ruby runners) and post results to the Checks API. The CheckRun API seems pretty stable. Hope this is helpful to someone!

Is there any interest in this supporting other languages or runners?

@jbielick
Copy link

jbielick commented Oct 9, 2019

@jbielick
Copy link

jbielick commented Apr 1, 2020

FYI we made a Github Action for running pronto with a Check Run formatter to handle this. Github Actions are given an App token so it was a good fit.

@ibrahima
Copy link
Contributor

@jbielick that looks great! I wonder if it could be upstreamed into pronto, or if there's some reason why it wouldn't work? I figure at least the formatter could be upstreamed right? I think that would make it easier to install arbitrary linters rather than having a fixed set of dependencies, in the way that the GitHub Actions Integration document describes. Curious to hear your thoughts, thanks!

@ashkulz ashkulz added enhancement help wanted Get involved! We'd love to have your help. labels Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement help wanted Get involved! We'd love to have your help.
Projects
None yet
Development

No branches or pull requests

8 participants