EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add mention of version_slug parameter when using webhook (#2599) 

Signed-off-by: Thanh Ha <zxiiro@linux.com>

Fixes #2138
test-36
Thanh Ha 2017-01-26 05:40:45 -05:00 committed by Berker Peksag
parent c8dd1893c9
commit e4d0c80c1c
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/webhooks.rst
View File

@ -48,6 +48,14 @@ look something along the lines of ``http://readthedocs.org/build/<project_name>`
Regardless of which revision control system you use, you can just hit this URL
to kick off a rebuild.
The following parameters available to customize the behavior of custom webhooks:
* ``'version_slug'``: The build version to trigger build for (defaults to ``'latest'``)
Example::
$ curl -X POST --data "version_slug=$VERSION" https://readthedocs.org/build/$PROJECT_NAME
You could make this part of a hook using Git_, Subversion_, Mercurial_, or
Bazaar_, perhaps through a simple script that accesses the build URL using
``wget`` or ``curl``.