Sends a GitHub pull request as a patch series via email
Disclaimer: This is not an official Google product.
Many open-source projects (such as the Linux kernel or the Ganeti project) accept patches only via their mailing lists.
This tool makes it easy to integrate contributors who prefer Github pull requests into mailing list review workflows.
- Sending a pull request to a mailing list takes no more than 1 command.
- Optional notification as a pull request comment that discussion shall be continued on the mailing list (instead of in the pull request).
- Support for force-pushes and thread tracking. After addressing review feedback, the improved patches can be force-pushed into the pull request, and the next invocation of this tool will send the next patch series as a reply to the previous email thread.
- Optionally it's possible to run the tool in daemon mode, let it receive GitHub webhooks and automatically process them.
Usage: pull-request-mailer USER REPO N --to EMAIL [--post-checkout-hook PROGRAM]
[--no-thread-tracking] [--discussion-location STRING]
Sends a GitHub pull request as a patch series via email
Available options:
-h,--help Show this help text
USER GitHub user who owns the repo containing the pull
request
REPO Repo containing the pull request
N Number of the pull request
--to EMAIL Email recipient
--post-checkout-hook PROGRAM
A program in the cloned direcotry just after checkout
--no-thread-tracking Disable posting thread message ID and patch iteration
count into the pull request. When active, future
versions of the PR can not be sent as reply to the
created email thread
--discussion-location STRING
The place where the contents of the PR are discussed
(as opposed to the discussion being in PR comments.
Example: 'the mailing list project@example.com'.
Available environment variables:
PULL_REQUEST_MAILER_OAUTH_TOKEN
Auth token needed to write information into the pull
request. You can generate one at
https://github.com/settings/applications.
PULL_REQUEST_MAILER_SECRET_TOKEN
Secret token to verify that requests really come from
Github. See
https://developer.github.com/webhooks/securing.
Usage: pull-request-mailer-server --to EMAIL [--post-checkout-hook PROGRAM]
[--no-thread-tracking]
[--discussion-location STRING]
Receive GitHub pull request webbooks and send the patch series via email
Available options:
-h,--help Show this help text
--to EMAIL Email recipient
--post-checkout-hook PROGRAM
A program in the cloned direcotry just after checkout
--no-thread-tracking Disable posting thread message ID and patch iteration
count into the pull request. When active, future
versions of the PR can not be sent as reply to the
created email thread
--discussion-location STRING
The place where the contents of the PR are discussed
(as opposed to the discussion being in PR comments.
Example: 'the mailing list project@example.com'.
Available environment variables:
PULL_REQUEST_MAILER_OAUTH_TOKEN
Auth token needed to write information into the pull
request. You can generate one at
https://github.com/settings/applications.
PULL_REQUEST_MAILER_SECRET_TOKEN
Secret token to verify that requests really come from
Github. See
https://developer.github.com/webhooks/securing.
The tool has been created and is maintained by the Ganeti team. Please send any questions to the ganeti-devel@googlegroups.com mailing list (also available online).