Custom GitHub Check Runs

[Wen Bo Li]

Hi,

I'm looking to display my GCB build results in a user-friendly way, and it seems like the Check Run feature of GitHub is a good choice, as it supports markdown and can show custom output.

So, I tried to use this to create a check run: https://godoc.org/github.com/google/go-github/github#ChecksService.CreateCheckRun

However, I got this HTTP reply: 403 Forbidden "You must authenticate via a GitHub App."

Is it possible to resolve this?

[Katayoon (Cloud Platform Support)]

Hi Wen,

As noted in the Authentication part, the go-github library does not directly handle authentication. It is not clear to me the steps you have taken and the code you have used to create a Check Run, however you may take a look at the code snippet provided in the Authentication part, which shows how to pass an http.Client that can handle authentication for you. 

If you need further assistance in coding, I recommend to post your fully detailed question on Stack Overflow; or if you think it is a bug, you may report it in the go-github Issue Tracker so that the Google Go library engineering team would look into the issue.

[Wen Bo Li]

Thanks Katayoon,

I've posted my question here, please see it for details. I still feel given that similar questions have been posted in the past [1] [2] without a satisfactory answer, that there should be some sort of answer from GCB on whether this is supported or not, or planning to be supported or not.

https://stackoverflow.com/questions/60047159/how-to-post-a-custom-check-run-in-github-from-google-cloud-build

[1] https://stackoverflow.com/questions/52636635/further-integrating-google-cloud-build-with-github-checks-api

[2] https://stackoverflow.com/questions/55869996/how-to-show-additional-information-on-github-checks-from-google-cloud-build-gith

[Katayoon (Cloud Platform Support)]

Hi again Wen,

I reached out to a Cloud Build specialist and she confirmed that, as you pointed out in the Stackoverflow thread, go-github mentions 'Write permission for the Checks API is only available to GitHub Apps.'. So, we currently do not support GCB authentication in this case. To understand if such a feature is on the roadmap and get more information about this feature we need to reach out to the Cloud Build product team. I'll try to provide you with an update by next Tuesday. 

[Wen Bo Li]

Thanks Katayoon

[Katayoon (Cloud Platform Support)]

Hi Wen,

The Cloud Build engineer also confirmed that you need to create your own GitHub app with its own credentials in order to write Check Runs and you cannot authenticate as the Google Cloud Build app, and this is not something they plan to support at this time. However, feel free to raise a feature request in the Issue Tracker so that you and other customers can better follow up your inquiry. 

Regarding the other Stackoverflow links you mentioned, the Cloud Build engineering team are actively working on sending the Trigger name rather than the trigger ID and hope to make more improvements soon so that the customers would have a better experience in GitHub when viewing check run results. Note that we can provide you with any ETA for now.