blob: 6bf621166e342b9cded69078eab0bdee0b9c76b6 [file] [log] [blame]
Chris Kay9666e882022-08-25 15:53:44 +01001- job:
2 name: tf-a-tftf-docs-watcher
Paul Sokolovsky940832d2023-08-09 00:46:11 +03003 node: docker-amd64-tf-a-jammy
Chris Kay9666e882022-08-25 15:53:44 +01004 project-type: freestyle
5 concurrent: false
Chris Kaybb674402025-06-24 15:20:02 +01006 description: Triggers whenever a code change is merged into the master branch of the TF-A-Tests repository. Executes a webhook to trigger the ReadTheDocs service to build a fresh copy of the documentation for one or more branches.
Chris Kay1c929b92022-10-11 10:46:31 +01007 disabled: false
Chris Kay9666e882022-08-25 15:53:44 +01008 builders:
Chris Kaybb674402025-06-24 15:20:02 +01009 - shell: |-
10 #!/bin/bash -e
Chris Kaydfdd51e2025-07-18 17:15:10 +010011 echo "Trigger ReadTheDocs build on the $RTD_BRANCHES branch and the latest version"
12 RTD_API="https://readthedocs.org/api/v3/projects/trustedfirmware-a-tests"
13 curl -s -X POST -H "Authorization: Token ${RTD_TOKEN}" ${RTD_API}/versions/$RTD_BRANCHES/builds/ | jq .
14 echo "Trigger build latest version"
15 curl -s -X POST -H "Authorization: Token ${RTD_TOKEN}" ${RTD_API}/versions/latest/builds/ | jq .
Chris Kay9666e882022-08-25 15:53:44 +010016 properties:
Chris Kaybb674402025-06-24 15:20:02 +010017 - build-discarder:
18 days-to-keep: 7
19 num-to-keep: 10
Chris Kay9666e882022-08-25 15:53:44 +010020 wrappers:
Chris Kaybb674402025-06-24 15:20:02 +010021 - timestamps
22 - credentials-binding:
23 - text:
24 credential-id: Trusted_Firmware_Tests_ReadTheDocs_Token
25 variable: RTD_TOKEN
Chris Kay9666e882022-08-25 15:53:44 +010026 parameters:
Chris Kaybb674402025-06-24 15:20:02 +010027 - string:
28 name: RTD_BRANCHES
29 default: master
30 description: |
31 The branch, or branches, to rebuild the documentation for.
Chris Kay9666e882022-08-25 15:53:44 +010032 publishers:
Chris Kaybb674402025-06-24 15:20:02 +010033 - workspace-cleanup