diff --git a/playbooks/publish/trigger-rtd.yaml b/playbooks/publish/trigger-rtd.yaml new file mode 100644 index 0000000000..39299da55b --- /dev/null +++ b/playbooks/publish/trigger-rtd.yaml @@ -0,0 +1,3 @@ +- hosts: localhost + roles: + - name: trigger-readthedocs diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml index bc6f98d965..0c3269873b 100644 --- a/zuul.d/jobs.yaml +++ b/zuul.d/jobs.yaml @@ -1171,6 +1171,28 @@ secret: release_ssh_key - gpg_key + +- job: + name: trigger-readthedocs-webhook + description: | + Trigger readthedocs to rebuild documentation + + Note this job requires some external setup. + + #. add the ``openstackci`` user as an admin to your RTD project + #. generate a webhook URL via the "Integrations" dashboard page + #. provide the ``id`` from that URL in a ``rtd_webhook_id`` variable + + You probably do not want to use this job directly, but rather + include the `docs-on-readthedocs template + `__ + + run: playbooks/publish/trigger-rtd.yaml + post-review: true + final: true + secrets: + - rtd_credentials + - job: name: project-config-check-main-yaml description: | diff --git a/zuul.d/projects.yaml b/zuul.d/projects.yaml index 81bdf9f7cd..54001174d0 100644 --- a/zuul.d/projects.yaml +++ b/zuul.d/projects.yaml @@ -5941,12 +5941,30 @@ name: openstack/gerrit-dash-creator templates: - publish-to-pypi + vars: + # for trigger-readthedocs-webhook + # NOTE(ianw): For initial testing. + # Revert to docs-on-readthedocs template when + # https://review.openstack.org/583834 + # merges. + rtd_webhook_id: '43048' check: jobs: - openstack-tox-pep8 + - build-openstack-sphinx-docs gate: jobs: - openstack-tox-pep8 + - build-openstack-sphinx-docs + post: + jobs: + - trigger-readthedocs-webhook + pre-release: + jobs: + - trigger-readthedocs-webhook + release: + jobs: + - trigger-readthedocs-webhook - project: name: openstack/gertty diff --git a/zuul.d/secrets.yaml b/zuul.d/secrets.yaml index c37baee55a..a7138a5425 100644 --- a/zuul.d/secrets.yaml +++ b/zuul.d/secrets.yaml @@ -541,6 +541,22 @@ ThQJ8JC5z8vhzSNuU0agdpPJJuO6sSmcDG7N1SIq/qIZg4198hhvnqC89sOHkI+6xFSfy V/PoMvnBDA+g9Qaz8dqNWB6N6AjjtLQV4ES5/jew3BCPFHfFueUfHzTzc+8TRE= +- secret: + name: rtd_credentials + data: + rtd_username: openstackci + rtd_password: !encrypted/pkcs1-oaep + - jmecsVW/fOuRCzAXMxJfv6n3Q0LHoEZIqTxB6eObCLWEvcpTTT6ybAMr9uWVnT0LsEIMw + PAbh9BLzOOz3xrI8u+23zAv2zU05vUG3KrbDfSC7PkLi6iUrxVNS6o9Av2qif+3RwIFsX + BX7SwiCd72VcHgYgZYe507BuXJ9nKRjcABn2gIpJdsIxNWHI0eOrU9MpcDyJzqGJN/Ett + 7G9p6KvShA1E2ambl9LQkpjchTdgx6pbBZkxG01VWU3CQghbj5CxlVsGvO9mC7zSuukhB + cKEq+zd/Tq2ogsYdhZ9W5shn+vPcOqSIRaK6I0FKaDfkdMPzW1S1VeCjtMojya0w6Op/c + t+mQ++EkrL61qabxNgp1XpmJQeRfXLWO/qcvUEYo8bmPoRtxcQolhOZTIqmUBz7KJKvO9 + U1Rs72vFkTcT2tCyjV9EuhwEr73IZdH4ZHYZXKusnh1h/YwEjiYV2pDbyakhxJZlWlFnk + bTN5pQKQFKIUpJP2yhPvjefGXGrpzk46cvPPA/9+Wl12K04HcRVeCSJCKA3DL2T38c7lv + s64C61Vx6Yntum+ptyY1I/fFzVdxlNOynMk4SDthBtV2f3LqfOyKLakxzZK4NI468K4tY + srbw9QBbmpl8T7xd6gn2HfKCFeqngOFDV7QGq0F95BZ3HamgDYpXhhOmEDdp3g= + - secret: name: openstackinfra_vexxhost data: @@ -565,3 +581,4 @@ project_domain_id: default user_domain_id: default region_name: ca-ymq-1 +