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
39 lines
1.3 KiB
YAML
39 lines
1.3 KiB
YAML
- name: Check for webhook id
|
|
fail:
|
|
msg: You must define the webhook id. Get this from the webhook info page on RTD
|
|
when: rtd_webhook_id is not defined
|
|
|
|
- name: Check for an authentication type
|
|
fail:
|
|
msg: Must set either rtd_username or rtd_integration_token
|
|
when: (rtd_username is not defined) and (rtd_integration_token is not defined)
|
|
|
|
- when: rtd_username is defined
|
|
block:
|
|
- name: Require password
|
|
fail:
|
|
msg: rtd_password is required when using rtd_username
|
|
when: rtd_password is not defined
|
|
|
|
- name: Trigger readthedocs build webhook via authentication
|
|
uri:
|
|
method: POST
|
|
url: 'https://readthedocs.org/api/v2/webhook/{{ rtd_project_name }}/{{ rtd_webhook_id }}/'
|
|
user: '{{ rtd_username }}'
|
|
password: '{{ rtd_password }}'
|
|
# NOTE(ianw): testing it seems the API doesn't respond with
|
|
# 401 so this is required
|
|
force_basic_auth: yes
|
|
|
|
- when: rtd_integration_token is defined and
|
|
rtd_username is not defined
|
|
block:
|
|
- name: Trigger readthedocs build webhook via token
|
|
uri:
|
|
method: POST
|
|
url: 'https://readthedocs.org/api/v2/webhook/{{ rtd_project_name }}/{{ rtd_webhook_id }}/'
|
|
body_format: form-urlencoded
|
|
body:
|
|
token: '{{ rtd_integration_token }}'
|
|
follow_redirects: all
|