zuul/zuul-jobs
Code Issues Proposed changes
6fb73060ec
zuul-jobs/roles/trigger-readthedocs
History
Ian Wienand 31116ed030 Revert "Debugging for readthedoc web ping" 
This reverts commit 5a38208e3b.

Turns out it was a badly encoded password; see
https://review.openstack.org/588182

Change-Id: Ib6c1d3c13340c1cacbc5c6b7e0a77841c0d78afb
2018-08-02 19:18:40 +10:00
..
defaults Add role to trigger readthedocs via authenticated endpoint 2018-07-19 12:27:51 +10:00
tasks Revert "Debugging for readthedoc web ping" 2018-08-02 19:18:40 +10:00
README.rst trigger-readthedocs: Move secret bits into a dict 2018-08-02 07:49:24 +10:00

README.rst

Trigger readthedocs build for a project

Role Variables

The readthedocs webhook API ID. This needs to be taken from the project's "Integrations" dashboard page in RTD. The URL will look like readthedocs.org/api/v2/webhook/<project-name>/<id>/.

This may come from a secret, however it can not be triggered without authentication.

Complex argument which contains the RTD authentication credentials. This is expected to come from a secret.

The webhook integration token. You'll find this value on the project's "Integrations" dashboard page in RTD. This can be used instead of username/password combo.

The readthedocs username. If set, this will be used to authenticate in preference to any token set via rtd_integration_token.

Password for username. Must be set if username is set.