zuul-jobs/roles/trigger-readthedocs
Ian Wienand 6d23d20f2f linters: add names to blocks
This is preparation for a later version of ansbile-lint, which finds
missing names on blocks.  This seems a reasonable rule, and the
Ansible manual says [1]

  Names for blocks have been available since Ansible 2.3. We recommend
  using names in all tasks, within blocks or elsewhere, for better
  visibility into the tasks being executed when you run the playbook.

This simply adds a name tag for blocks that are missing it.  This
should have no operational change, but allows us to update the linter
in a follow-on change.

[1] https://docs.ansible.com/ansible/latest/user_guide/playbooks_blocks.html

Change-Id: I92ed4616775650aced352bc9088a07e919f1a25f
2022-07-27 17:13:39 +10:00
..
defaults Add role to trigger readthedocs via authenticated endpoint 2018-07-19 12:27:51 +10:00
tasks linters: add names to blocks 2022-07-27 17:13:39 +10:00
README.rst trigger-readthedocs: Move secret bits into a dict 2018-08-02 07:49:24 +10:00

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.

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.