70fef1a858
The old API endpoint is deprecated, so add a role that pings the webhook as described in [1]. Authentication can happen via a token or username/password combo, which need to be kept in secrets. The webhook api has an "id" value which some fiddling suggests is an incrementing integer each time a webhook endpoint is generated (if you create, delete, create your webhook via the admin interface, you often as not get the next value). Unfortunately, it appears you can not query this in any way automatically; it has to be provided. However, I do not believe this has to be secret; you can not trigger the end-point without authentication (either password or token). This means the generic playbook here will not work any more. Because secrets are bound to the playbook they are defined within, this role will need to be called directly. It will be removed in a follow-on. [1] https://docs.readthedocs.io/en/latest/webhooks.html Change-Id: I651efdb093df85cea3ab2eaf1a5a9256c87a2ca4 |
||
|---|---|---|
| .. | ||
| defaults | ||
| tasks | ||
| 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.
The webhook integration token. You'll find this value on the project's "Integrations" dashboard page in RTD. This is expected to come from a secret. 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
rtd_username. Must be set if password is set. This is expected to come from a secret.