Skip to content

Commit

Permalink
Add mention of version_slug parameter when using webhook (#2599)
Browse files Browse the repository at this point in the history
Signed-off-by: Thanh Ha <zxiiro@linux.com>

Fixes #2138
  • Loading branch information
zxiiro authored and berkerpeksag committed Jan 26, 2017
1 parent c8dd189 commit e4d0c80
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/webhooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
Expand Down

0 comments on commit e4d0c80

Please sign in to comment.