zuul-jobs/roles/trigger-readthedocs
Slawek Kaplonski f2bc6bb699
Use "curl" to trigger rtd.org webhook with http basic auth
For some reason (unknown really for us) triggering webhook with http
basic auth using Ansible's uri module started recently failing when it
is run on some operating systems, like e.g. Ubuntu Noble.

Let's switch to use curl command directly to trigger that webhook
instead.

Change-Id: Idbf643ea27220504ac9e37eaf9f18930d2fc08ab
2024-11-08 22:19:39 +11:00
..

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.