RFE: Update `details_url` in API and webhook payloads to point to details for check run

When most CI providers create a check run, the API and webhook payloads for the check run use the details_url field to link to the details for that specific build. A few examples:

Travis CI
“details_url”: “https://travis-ci.com/notjasonrudolph-inc-for-unserious-works/canary/builds/130411149”,
“html_url”: “https://github.com/notjasonrudolph-inc-for-unserious-works/canary/runs/247911378”,

CircleCI
“details_url”: “https://circleci.com/workflow-run/68d9f438-2f52-4416-917a-3bc8d649b452?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-checks-link”,
“html_url”: “https://github.com/notjasonrudolph-inc-for-unserious-works/canary/runs/247911382”,

Azure Pipelines
“details_url”: “https://dev.azure.com/atom-github/b5f32a1b-1986-4a7d-bfcc-952d682a0d22/_build/results?buildId=3099&view=logs&jobId=0da5d1d9-276d-5173-c4c4-9d4d4ed14fdb”,
“html_url”: “https://github.com/atom/github/runs/244080585”,

This convention allows consumers of these payloads to use the details_url as the link to the build’s details.

It would be awesome if GitHub Actions CI followed this convention as well. Currently, when GitHub Actions CI creates a check run, the details_url points to https://developer.github.com/actions/. The real details URL is in the html_url field. Example:

“details_url”: “https://developer.github.com/actions/”,
“html_url”: “https://github.com/notjasonrudolph-inc-for-unserious-works/canary/runs/246006838”,

As a consumer of check run payloads for numerous CI providers, it would be a big help if GitHub Actions CI followed the convention of populating the details_url field with details URL for the specific build involved in the check run? Could I talk y’all into making that change?

2 Likes

Hi @jasonrudolph,

Thanks for being here and our sincere apologies for the delayed response. I’ve logged your feature request in our internal feature request list. Though I can’t guarantee anything or share a timeline for this, I can tell you that it’s been shared with the appropriate teams for consideration.

Please let me know if you have any other questions.