Support GitHub "Check Runs"


#1

GitHub offers a “Check Runs” API that allows very rich integration of build results into the GitHub pull request experience.

This feature is in Preview on GitHub but services like Azure Pipelines and Netlify have already implemented it in Production, and I’d love for Buildkite to support it too.

Blog post: https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/
API reference: https://developer.github.com/v3/checks/runs/

Here’s an example pull request using Azure Pipelines: https://github.com/prettier/prettier/pull/5749/checks?check_run_id=50147856

I won’t dictate any solutions, but it seems like a perfect fit for buildkite-agent annotate, the markdown messages could be forwarded directly to GitHub.


#2

Hi @azz, we’ve actually been pondering this one! We’ve got some updates to our GitHub integrations on the horizon, and this is likely going to be part of it.

One of the problems is that our annotations don’t map to GitHub checks at all; check annotations can point to a particular line, yes, but they’re plain-text (yuk!) which is a bit awkward. We’re trying to find a way to let you use the strengths of both :smile:


#3

Hi @jess, that’s awesome to hear. Looking forward to see what you’ve got coming up!