Skip to content
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

Jump to bottom

docs(webhook): adding GitLab doc to webhooks #2747

Merged
merged 1 commit into from Mar 30, 2017
Merged

docs(webhook): adding GitLab doc to webhooks #2747

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 13 additions & 1 deletion docs/webhooks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,18 @@ your docs whenever you push updates:
If you ever need to manually set the webhook on Bitbucket,
you can point it at ``https://readthedocs.org/bitbucket``.

GitLab
---------

If your project is hosted on GitLab, you can easily add a hook that will rebuild
your docs whenever you push updates.

* Go to the "Settings" page for your project
* Click "Integrations"
* In the "URL" section, enter ``https://readthedocs.org/gitlab``
* Leave the default "Push events" selected
* Click "Add Webhook"

Others
------

Expand All @@ -53,7 +65,7 @@ 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
Expand Down