[FeatureRequest] GraphQL / MergeQueue | Get required checks for all entries

[tj-smith47]

Select Topic Area

Product Feedback

Body

Given that one of the primary benefits of GraphQL is to reduce the total number of calls one would need to make to get the information they need, there is a shortcoming with inspecting MergeQueues that would require multiple calls to be made. As you know, there isn't a REST API alternative for merge queues, so hoping this request would be easier to implement a fix for.

Specifically, the only reason I need to look into the queue is to know the status of all required check runs. Perhaps I'm just too new to GraphQL to know how and there's a way to do this without 1 request per PR in the queue, but consider the following query:

query Repository($orgName: String!, $repoName: String!, $branch: String!) {
    repository(owner: $orgName, name: $repoName) {
        mergeQueue(branch: $branch) {
            entries(first: 50) {
                nodes {
                    baseCommit {
                        oid
                    }
                    enqueuer {
                        login
                    }
                    enqueuedAt
                    headCommit {
                        oid
                        checkSuites(first: 15) {
                            nodes {
                                checkRuns(first: 25) {
                                    nodes {
                                        name
                                        status
                                        conclusion
                                        isRequired    <-- Here lies the limitation
                                    }
                                }
                            }
                        }
                    }
                    position
                    state
                }
            }
        }
    }
}

My problem is that when making this request, I have neither of the 2 potential args that could be passed to isRequired - pullRequestId, or pullRequestNumber. But why I need that doesn't make any sense. A status check is required against a branch, not a pull request - is there a good reason I shouldn't be able to pass a branch here? If so, I'm left with:

1. Make a list of all the PR numbers I think are in the queue
2. Query into the PR object of MergeQueueEntry to get a list of id's / numbers

Unfortunately, both of these require making multiple queries.

Ideally I could just pass a repo name and default branch, get all entries in the queue for that branch, all check suites on the head commit for the PR in the queue, and then get the status and conclusion of all required check runs in a single query. I do not want MergeQueueEntryState - I need to know when all but one specific required check is complete, so I will always get "AWAITING_CHECKS" at the point I need the information. If there's already a way to do this, any help would be greatly appreciated! Alternatively, if there are any upcoming changes related to Merge Queues in either API on the roadmap that will solve for this, I'd love to hear about them 🙏 Thanks in advance!

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐