Skip to content

Add mention of version_slug parameter when using webhook #2599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 26, 2017
Merged

Add mention of version_slug parameter when using webhook #2599

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1197f6
Add mention of version_slug parameter when using webhook
zxiiro Jan 20, 2017
cb6466c
Tweak wording a bit
berkerpeksag Jan 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/webhooks.rst
View file
Open in desktop
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