Help:Toolforge/Auto-update a tool from GitHub

Toolforge
Toolforge technical documentation Toolforge administrator documentation Help and communication List of tools Terms and conditions Glossary Technical documentation resources
Getting started Cloud VPS and Toolforge at a glance About Toolforge Toolforge quickstart guide How-tos, tutorials and walkthroughs Create a Wikimedia developer account Access Toolforge instances with PuTTY and WinSCP Troubleshooting Toolforge
Developing tools Tool accounts How to develop tools Develop Mono/.NET tools and bots Develop tools in Java Develop tools in Python Develop tools using Pywikibot framework Web servers for tools (Kubernetes) Grid engine
Additional documentation Version control in Toolforge Elasticsearch for Toolforge Redis for Toolforge Dumps and Toolforge Database

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.

You can find helpful introductory-level information about using webhooks with GitHub here and here.

PHP tool hosted in $HOME/public_html

First, set up a webhook listener that runs "git pull" whenever it's accessed from GitHub:

1. ssh USER@login.tools.wmflabs.org
2. become MYTOOL
3. echo "<?php if(isset($_SERVER['HTTP_X_GITHUB_EVENT'])) { `git pull`; } ?>" > public_html/git-pull.php
   • You can add more commands after git pull, e.g. to run a build script.
   • You can find useful information regarding running shell commands from PHP here and here.

Then, set up the webhook emitter on GitHub's side:

1. Go to https://github.com/USER/REPO/settings/hooks and click the "Add webhook" button
2. In the "Payload URL" field, type https://tools.wmflabs.org/MYTOOL/git-pull.php
3. 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:

1. ssh USER@login.tools.wmflabs.org
2. become MYTOOL
3. mkdir ~/public_html
4. echo "<?php if(isset($_SERVER['HTTP_X_GITHUB_EVENT'])) { `git -C ../www/static pull`; } ?>" > public_html/git-pull.php
5. webservice start

Then, set up the webhook emitter on GitHub's side:

1. Go to https://github.com/USER/REPO/settings/hooks and click the "Add webhook" button
2. In the "Payload URL" field, type https://tools.wmflabs.org/MYTOOL/git-pull.php
3. 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.