zuul-jobs/roles/trigger-readthedocs/README.rst

1.1 KiB

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.