openedx / openedx/openedx-webhooks
Support Reporting CLA Status on Merge Queue Events
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 22
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 4
Description
We want to enable merge queues. But for that to work, all required checks must pass on the items in the merge queue independently of them passing on the PR. This means for the CLA check, we need to listen for items being added to the merge queue and pass back a CLA check status on them.
Notes for the implementer
This might be a bit complicated because the merge queue does not have a link back to the PR in the webhook payload: https://docs.github.com/en/webhooks/webhook-events-and-payloads#merge_group
We may need to check that the CLA check passes on the author of each commit in the merge_group instead.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the webhook handling for GitHub merge_group events and the merge_group payload documentation linked in the issue. Determine how CLA status can be reported for queued items without a pull-request link, including the listed commit authors; done means required CLA checks are returned for merge queue items.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100