Repository navigation
gh pr checks should show output summary of checks #5634
Description
Activity
Thanks for the feature request. We like this idea, and we agree that it would be useful to expose this text in the CLI. We're not sure about the name
--summary, though, as "job summaries" are something different.I wonder which API field exposes the text
Terraform plan has no changescome from. Might it be thetitlefield?@jgrumboe Could you check by doing a manual API query on your end and report back:
# 1. replace "123" with your PR number # 2. optionally replace "{owner}" and "{repo}" with your repository information gh api graphql -F owner='{owner}' -F repo='{repo}' -F pr=123 -f query=' query ($owner: String!, $repo: String!, $pr: Int!) { repository(owner: $owner, name: $repo) { pullRequest(number: $pr) { commits(last: 1) { nodes { commit { statusCheckRollup { state contexts(first: 100) { nodes { __typename ... on CheckRun { name checkSuite { workflowRun{workflow{name}} } text title } } } } } } } } } } '
Hi @mislav
The output for one example PR is as follows:
{ "data": { "repository": { "pullRequest": { "commits": { "nodes": [ { "commit": { "statusCheckRollup": { "state": "SUCCESS", "contexts": { "nodes": [ { "__typename": "StatusContext" }, { "__typename": "StatusContext" }, { "__typename": "StatusContext" }, { "__typename": "StatusContext" }, { "__typename": "StatusContext" }, { "__typename": "StatusContext" }, { "__typename": "StatusContext" }, { "__typename": "StatusContext" } ] } } } } ] } } } } }Does this help?
I too agree this feature would be extremely helpful for a similar use case. Anything we can do to help?
For tickets marked help wanted, feel free to announce intent to work on a thing and ask specific questions about implementation as needed.
Describe the feature or problem you’d like to solve
In GitHub UI I see summaries to checks run by Terraform Cloud for a pull request.
The command
gh pr checksfor the same PR looks like this:I would like to see the summary
Terraform plan: 6 to add, 0 to change, 0 to destroy.when runninggh pr checks(maybe also with some--summaryoption).Proposed solution
gh pr checks --summarycould be a proposal to show the summary for each check. Maybe a new column before the links.Additional context
Use case for me is to auto-approve pull requests where the summary output of each check is
Terraform plan has no changes.