bd4e5a54d7
What I missed when I layed this out was that you setup a secret like
- secret:
name: rtd_credentials
data:
username: openstackci
password: foo
what you have in the job variables is a dictionary called
"rtd_credentials".
It makes it much simpler to use the role with the secret if it accepts
this variable, rather than having to extract the username/password etc
out of the secret dictionary into separate variables.
Additionally, turn on no_log for the uri calls, to avoid potentially
logging any credentials.
Change-Id: I514fb1285196aae0b49a98f0efc21326730e4179
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.