Help:Toolforge/Auto-update a tool from GitHub
![]() | Note: Use of this deployment method has risks. If your GitHub repository is compromised by a 3rd party, your live tool could be impacted. Please think carefully before proceeding. |
Overview
You can use GitHub's webhooks feature to automatically deploy any changes made on GitHub to Toolforge. With this setup, whenever a push is made to the repository on GitHub, the changes will be fetched to the Toolforge clone of the repository, without having to manually log in to the tool's account and running git pull
.
Using webhooks with Github
Introductory-level information about using webhooks with GitHub can be found here:
PHP tool hosted in $HOME/public_html
First, set up a webhook listener that runs "git pull" whenever it's accessed from GitHub:
ssh USER@login.toolforge.org
become MYTOOL
echo "<?php if(isset($_SERVER['HTTP_X_GITHUB_EVENT'])) { `git pull`; } ?>" > public_html/git-pull.php
Then, set up the webhook emitter on GitHub's side:
- Go to
https://github.com/USER/REPO/settings/hooks
and click the "Add webhook" button - In the "Payload URL" field, type
https://MYTOOL.toolforge.org/git-pull.php
- Save the hook (the remaining fields can be kept with the default values)
That's it! Now whenever you push commits to the repo on GitHub, the Toolforge clone will be automatically updated.
PHP tool hosted in $HOME/www/static
First, set up a webhook listener (in the non-static $HOME/public_html
directory) that runs "git pull" whenever it's accessed from GitHub:
ssh USER@login.toolforge.org
become MYTOOL
mkdir ~/public_html
echo "<?php if(isset($_SERVER['HTTP_X_GITHUB_EVENT'])) { `git -C ../www/static pull`; } ?>" > public_html/git-pull.php
webservice start
Then, set up the webhook emitter on GitHub's side:
- Go to
https://github.com/USER/REPO/settings/hooks
and click the "Add webhook" button - In the "Payload URL" field, type
https://MYTOOL.toolforge.org/git-pull.php
- Save the hook (the remaining fields can be kept with the default values)
That's it! Now whenever you push commits to the repo on GitHub, the Toolforge clone will be automatically updated.
Communication and support
Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia Movement volunteers. Please reach out with questions and join the conversation:
- Chat in real time in the IRC channel #wikimedia-cloud connect, the bridged Telegram group, or the bridged Mattermost channel
- Discuss via email after you subscribed to the cloud@ mailing list