tf-a-docs-watcher.yaml: Adding tf-docs-watcher for tfc-113 to address tf-a gap.
This request addresses a tfa-gap in tfc-113. ArmCI is currently maintaning
the read the docs which needs to be transferred over to OpenCI.
Currently there is an open STG ticket for adding the secret auth token
RTD_TOKEN which needs to be completed before merging this request.
https://linaro.atlassian.net/browse/STG-2939
Signed-off-by: Theodore Grey <theodore.grey@linaro.org>
Change-Id: Id1715204f148e310ac901dad6a1e65514ca7fdf1
diff --git a/tf-a-docs-watcher.yaml b/tf-a-docs-watcher.yaml
new file mode 100644
index 0000000..00fef1a
--- /dev/null
+++ b/tf-a-docs-watcher.yaml
@@ -0,0 +1,45 @@
+- job-template:
+ name: tf-a-docs-watcher
+ node: docker-amd64-tf-a-bionic
+ project-type: freestyle
+ concurrent: false
+ description:
+ Triggers whenever a code change is merged into the master branch of the
+ TF-A repository. Executes a webhook to trigger the ReadTheDocs service to
+ build a fresh copy of the documentation for one or more branches.
+ disabled: false
+ builders:
+ - shell: |-
+ #!/bin/bash -e
+ echo "Notifying ReadTheDocs of changes on: $RTD_BRANCHES"
+ curl -X POST -d "branches=$RTD_BRANCHES" -d "token=$RTD_TOKEN" https://readthedocs.org/api/v2/webhook/trustedfirmware-a/87181/
+ properties:
+ - build-discarder:
+ days-to-keep: 7
+ num-to-keep: 10
+ triggers:
+ - gerrit:
+ silent: true
+ server-name: 'review.trustedfirmware.org'
+ projects:
+ - branches:
+ - branch-compare-type: ANT
+ branch-pattern: master
+ project-compare-type: PLAIN
+ project-pattern: 'TF-A/trusted-firmware-a'
+ trigger-on:
+ - ref-updated-event
+ wrappers:
+ - timestamps
+ - credentials-binding:
+ - text:
+ credential-id: Trusted_Firmware_ReadTheDocs_Token
+ variable: RTD_TOKEN
+ parameters:
+ - string:
+ name: RTD_BRANCHES
+ default: master
+ description: |
+ The branch, or branches, to rebuild the documentation for.
+ publishers:
+ - workspace-cleanup