tf-a-docs-watcher.yaml

- job:
    name: tf-a-docs-watcher
    node: docker-amd64-tf-a-jammy
    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 "Trigger ReadTheDocs build on the $RTD_BRANCHES branch and the latest version"
          RTD_API="https://readthedocs.org/api/v3/projects/trustedfirmware-a"
          echo "Trigger build $RTD_BRANCHES branch"
          curl -s -X POST -H "Authorization: Token ${RTD_TOKEN}" ${RTD_API}/versions/$RTD_BRANCHES/builds/ | jq .
          echo "Trigger build latest version"
          curl -s -X POST -H "Authorization: Token ${RTD_TOKEN}" ${RTD_API}/versions/latest/builds/ | jq .
    properties:
      - build-discarder:
          days-to-keep: 60
          num-to-keep: 10
    wrappers:
      - timestamps
      - credentials-binding:
          - text:
              credential-id: TF-A-RTD-API-TOKEN
              variable: RTD_TOKEN
    parameters:
      - string:
          name: RTD_BRANCHES
          default: master
          description: |
            The branch, or branches, to rebuild the documentation for.
    publishers:
      - workspace-cleanup