firmware-development-guide-main.yaml

- job:
    name: firmware-development-guide-main
    node: docker-amd64-tf-a-jammy
    project-type: multijob
    concurrent: true
    disabled: false
    description: Main CI job for the firmware-development-guide crate
    properties:
      - throttle:
          option: project
          enabled: true
          max-total: 5
      - build-discarder:
          days-to-keep: 14
          num-to-keep: 60
    triggers:
      - gerrit:
          server-name: review.trustedfirmware.org
          projects:
            - branches:
                - branch-compare-type: PLAIN
                  branch-pattern: main
              project-compare-type: PLAIN
              project-pattern: rust-spmc/firmware-development-guide
          trigger-on:
            - patchset-created-event:
                exclude-drafts: true
                exclude-trivial-rebase: true
                exclude-no-code-change: true
                exclude-private: true
                exclude-wip: true
            - comment-added-contains-event:
                comment-contains-value: ^RUN_CI$
          override-votes: true
          gerrit-build-started-verified-value: 0
          gerrit-build-successful-verified-value: 1
          gerrit-build-failed-verified-value: -1
          gerrit-build-unstable-verified-value: -1
          gerrit-build-notbuilt-verified-value: 0
          # without explicitly setting these values to 0, the plugin will by
          # default leave Code Review votes
          gerrit-build-started-codereview-value: 0
          gerrit-build-successful-codereview-value: 0
          gerrit-build-failed-codereview-value: 0
          gerrit-build-unstable-codereview-value: 0
          gerrit-build-notbuilt-codereview-value: 0
          silent: false
          silent-start: false
    parameters:
      # GERRIT_{PROJECT,BRANCH,REFSPEC} are set when triggered by a Gerrit
      # patchset - defaults below are for manual triggers
      - string:
          name: GERRIT_PROJECT
          default: rust-spmc/firmware-development-guide
      - string:
          name: GERRIT_BRANCH
          default: refs/heads/main
      - string:
          name: GERRIT_REFSPEC
          default: +refs/heads/main:refs/remotes/origin/main
          description: |
            'e.g. refs/changes/13/31138/1'
      - string:
          name: ARM_FW_DEV_GUIDE_GERRIT_REFSPEC
          default: ${GERRIT_REFSPEC}
          description: |
            'do-not-amend: used by scripts/clone.sh to fetch the correct Gerrit patchset - use GERRIT_REFSPEC instead'
      - string:
          name: CI_REFSPEC
          default: +refs/heads/rf-a:refs/remotes/origin/rf-a
          description: |
            'Refs to fetch for the tf-a-ci-scripts repo e.g. refs/changes/13/31138/1'
      - string:
          name: JOBS_REFSPEC
          default: refs/heads/master
          description: |
            tf-a-job-configs refspec to use. The master branch is used by default.
      - string:
          name: TEST_FEATURES
          description: Features the firmware-development-guide crate will be tested against
      - string:
          name: SHARE_FOLDER
          default: /srv/shared/${JOB_NAME}/${BUILD_NUMBER}
          description: Folder containing shared repositories for downstream pipeline jobs
      - string:
          name: CLONE_REPOS
          default: tf-a-ci-scripts,firmware-development-guide
          description: |
            Optional arg to clone only specific projects from default list (tf-a-ci-scripts,trusted-firmware-a,tf-a-tests,spm,tf-m-tests,tf-m-extras,etc.)
    wrappers:
      - credentials-binding:
          - ssh-user-private-key:
              credential-id: TFA_CI_BOT_USER_SSH_KEY
              key-file-variable: CI_BOT_KEY
              username-variable: CI_BOT_USERNAME
              passphrase-variable: ""
      - workspace-cleanup
      - timestamps
    builders:
      - shell: !include-raw: scripts/clone.sh
      - shell: |
          #!/bin/bash
          set -e
          cat << EOF > tf-a-env.param
          ARM_FW_DEV_GUIDE_GERRIT_PROJECT=${GERRIT_PROJECT}
          ARM_FW_DEV_GUIDE_GERRIT_REFSPEC=${GERRIT_REFSPEC}
          SHARE_FOLDER=${SHARE_FOLDER}
          EOF
      - multijob:
          name: Platform independent tests
          condition: COMPLETED
          projects:
            - name: generic-lib-testing
              current-parameters: true
              kill-phase-on: NEVER
              predefined-parameters: |
                TEST_REPO_NAME=firmware-development-guide
                TEST_REPO_PROJECT=rust-spmc
                TEST_FEATURES=${TEST_FEATURES}
              property-file: tf-a-env.param