commit 2a34a323eef0aa01e742d1213c5ff09a814832f7
author Leonardo Sandoval <leonardo.sandoval@linaro.org> Mon May 17 12:16:20 2021 -0500
committer Leonardo Sandoval <leonardo.sandoval@linaro.org> Mon May 17 12:34:14 2021 -0500
tree 530de7978144c00c25ebaf046560f22f7d289eda
parent 6816d7adee12f246af26235508deefc7e544a3e2

tf-ci-users-guide: introduce job to trigger readthedocs build

Introduce job that for every merge-event on the TF Open CI Users Guide
documentation repository [1], a build on 'readthedocs' is triggered,
updating documentation [2] based on the introduced change.

[1] https://git.trustedfirmware.org/ci/tf-ci-users-guide.git/
[2] https://tf-ci-users-guide.readthedocs.io/en/latest/

Signed-off-by: Leonardo Sandoval <leonardo.sandoval@linaro.org>
Change-Id: I16e2609f5d03edf43ed83d3732a46f3ec1ea099c

ci-users-guide.yaml

diff --git a/ci-users-guide.yaml b/ci-users-guide.yaml
new file mode 100644
index 0000000..c751e3f
--- /dev/null
+++ b/ci-users-guide.yaml
@@ -0,0 +1,70 @@
+- job:
+    name: ci-users-guide
+    project-type: freestyle
+    defaults: global
+    properties:
+        - authorization:
+            anonymous:
+                - job-read
+                - job-extended-read
+        - build-discarder:
+            days-to-keep: 90
+            num-to-keep: 200
+    disabled: false
+    node: master
+    concurrent: false
+    display-name: 'CI Users Guide publish deployment'
+    scm:
+        - git:
+            url: https://review.trustedfirmware.org/${GERRIT_PROJECT}
+            refspec: ${GERRIT_REFSPEC}
+            branches:
+                - ${GERRIT_BRANCH}
+            skip-tag: true
+            clean:
+                before: true
+            choosing-strategy: gerrit
+            basedir: tf-ci-users-guide
+    parameters:
+        - string:
+            name: GERRIT_PROJECT
+            default: 'ci/tf-ci-users-guide'
+        - string:
+            name: GERRIT_BRANCH
+            default: 'refs/heads/master'
+        - string:
+            name: GERRIT_REFSPEC
+            default: '+refs/heads/master:refs/remotes/origin/master'
+        - string:
+            name: READTHEDOCS_PROJECT
+            default: 'tf-ci-users-guide'
+        - string:
+            name: READTHEDOCS_API
+            default: 'https://readthedocs.org/api/v3/projects/${READTHEDOCS_PROJECT}/versions/latest/builds/'
+    triggers:
+        - gerrit:
+            server-name: 'review.trustedfirmware.org'
+            trigger-on:
+                - change-merged-event
+            projects:
+                - project-compare-type: 'PLAIN'
+                  project-pattern: 'ci/tf-ci-users-guide'
+                  branches:
+                    - branch-compare-type: 'PLAIN'
+                      branch-pattern: 'master'
+            silent-start: true
+    execution-strategy:
+        sequential: false
+    wrappers:
+        - timestamps
+        - credentials-binding:
+            - text:
+                credential-id: READTHEDOCS_TOKEN
+                variable: READTHEDOCS_TOKEN
+    builders:
+        - shell: |
+            #!/bin/bash -xe
+            curl -X POST -H "Authorization: Token ${READTHEDOCS_TOKEN}" ${READTHEDOCS_API}
+    publishers:
+        - email:
+            recipients: linaro-infrastructure-errors@lists.linaro.org