| commit | cef79aa4975611bae9c732434373d87f43be696e | [log] [tgz] |
|---|---|---|
| author | David Arthur <mumrah@gmail.com> | Fri Aug 30 14:41:14 2024 -0400 |
| committer | GitHub <noreply@github.com> | Fri Aug 30 14:41:14 2024 -0400 |
| tree | eb45249179bb2ef081e5ec76b8d708681d724bda | |
| parent | 59f965be1b187e109481450a652536bd155d2844 [diff] |
Update README.md
The purpose of this repository is to evaluate Github's merge queue feature in the context of an Apache project.
See https://issues.apache.org/jira/browse/LEGAL-599 for additional context.
Follow the instructions here to install smee: https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/testing-webhooks
We need a Python virtualenv for running a local server.
python3 -m venv venv source venv/bin/activate
Download the quart framework https://github.com/apache/infrastructure-asfquart/ and install it into the virtualenv we just made.
Now, we can start the SMEE client to start receiving events from GitHub.
smee -u https://smee.io/wfaiAis5XU4SHXrC -t http://localhost:3000/webhook
This will receive events from the SMEE proxy which this repository is sending its webhooks to. The events will be forwarded to a local server listening on 3000
Start the Python webhook receiver on 3000 to receive the forwarded events.
python webhook-receiver.py
Generate some events in this repository (open pull request, merge pull request, etc)
Three event payloads are included in this repo. This can be used to simulate webhooks coming from GitHub.
curl -X POST http://localhost:3000/webhook \
-H "Content-Type: application/json" \
-H "X-Github-Event: pull_request" \
--data-binary "@webhook-payloads/pull_request_dequeued.json"
The three JSON payloads located in webhook-payloads require a cooresponding X-Github-Event header.
X-Github-Event: pull_requestX-Github-Event: pull_requestX-Github-Event: merge_group