Chris Kay | 9666e88 | 2022-08-25 15:53:44 +0100 | [diff] [blame] | 1 | - job: |
| 2 | name: tf-a-tftf-docs-watcher |
Paul Sokolovsky | 940832d | 2023-08-09 00:46:11 +0300 | [diff] [blame] | 3 | node: docker-amd64-tf-a-jammy |
Chris Kay | 9666e88 | 2022-08-25 15:53:44 +0100 | [diff] [blame] | 4 | project-type: freestyle |
| 5 | concurrent: false |
Chris Kay | bb67440 | 2025-06-24 15:20:02 +0100 | [diff] [blame] | 6 | 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 Kay | 1c929b9 | 2022-10-11 10:46:31 +0100 | [diff] [blame] | 7 | disabled: false |
Chris Kay | 9666e88 | 2022-08-25 15:53:44 +0100 | [diff] [blame] | 8 | builders: |
Chris Kay | bb67440 | 2025-06-24 15:20:02 +0100 | [diff] [blame] | 9 | - shell: |- |
| 10 | #!/bin/bash -e |
Chris Kay | dfdd51e | 2025-07-18 17:15:10 +0100 | [diff] [blame] | 11 | 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 Kay | 9666e88 | 2022-08-25 15:53:44 +0100 | [diff] [blame] | 16 | properties: |
Chris Kay | bb67440 | 2025-06-24 15:20:02 +0100 | [diff] [blame] | 17 | - build-discarder: |
| 18 | days-to-keep: 7 |
| 19 | num-to-keep: 10 |
Chris Kay | 9666e88 | 2022-08-25 15:53:44 +0100 | [diff] [blame] | 20 | wrappers: |
Chris Kay | bb67440 | 2025-06-24 15:20:02 +0100 | [diff] [blame] | 21 | - timestamps |
| 22 | - credentials-binding: |
| 23 | - text: |
| 24 | credential-id: Trusted_Firmware_Tests_ReadTheDocs_Token |
| 25 | variable: RTD_TOKEN |
Chris Kay | 9666e88 | 2022-08-25 15:53:44 +0100 | [diff] [blame] | 26 | parameters: |
Chris Kay | bb67440 | 2025-06-24 15:20:02 +0100 | [diff] [blame] | 27 | - string: |
| 28 | name: RTD_BRANCHES |
| 29 | default: master |
| 30 | description: | |
| 31 | The branch, or branches, to rebuild the documentation for. |
Chris Kay | 9666e88 | 2022-08-25 15:53:44 +0100 | [diff] [blame] | 32 | publishers: |
Chris Kay | bb67440 | 2025-06-24 15:20:02 +0100 | [diff] [blame] | 33 | - workspace-cleanup |