Support GitHub merge queues when RTD PR builds are required to merge

[gipert]

Details

I tried to enable GitHub's merge queue on a project that enables reporting PR builds on GitHub and sets it as a required status check before merging.

Expected Result

The PR is automatically merged after all checks have passed.

Actual Result

GitHub waits for ReadTheDocs to report the PR status check, which is never reported. The PR stays in the queue and is never merged.

Related?

I had to add on: merge_group: [ref] to my GHA workflow file to fix a similar problem with the other required status checks run with GitHub Actions.

[webknjaz]

@humitos I was just about to file a similar report. This is a blocker for projects wanting to use RTD with Merge Queues enabled.

I want to add that GitHub issues a push event in addition to merge_group, but RTD doesn't seem to react to it either.

This is what a deadlock this causes looks like: