---
####################
# COMMON FUNCTIONS #
####################

- _lf_rtd_common: &lf_rtd_common
    name: lf-rtd-common

    ######################
    # Default parameters #
    ######################
    gerrit_trigger_file_paths:
      - compare-type: REG_EXP
        pattern: '.*\.css'
      - compare-type: REG_EXP
        pattern: '.*\.html'
      - compare-type: REG_EXP
        pattern: '.*\.rst'
      - compare-type: REG_EXP
        pattern: '.*\/conf.py'

    # github_included_regions MUST match gerrit_trigger_file_paths
    github_included_regions:
      - '.*\.css'
      - '.*\.html'
      - '.*\.rst'
      - '.*\/conf.py'

    #####################
    # Job Configuration #
    #####################

    project-type: freestyle
    node: "{build-node}"

    properties:
      - lf-infra-properties:
          build-days-to-keep: 7

    parameters:
      - lf-infra-parameters:
          project: "{project}"
          branch: "{branch}"
          refspec: "refs/heads/{branch}"
          stream: "{stream}"

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    publishers:
      - lf-infra-publish

#############
# RTD MERGE #
#############

- _lf_rtd_merge: &lf_rtd_merge
    name: lf-rtd-merge

    ######################
    # Default parameters #
    ######################

    branch: master
    build-days-to-keep: 7
    build-timeout: 15
    disable-job: false
    git-url: https://github.com
    github-url: "https://github.com"
    project-pattern: "**"
    stream: master
    submodule-recursive: true

    gerrit_merge_triggers:
      - change-merged-event
      - comment-added-contains-event:
          comment-contains-value: '^Patch Set\s+\d+:\s+remerge\s*$'

    #####################
    # Job Configuration #
    #####################

    disabled: "{disable-job}"

    builders:
      - lf-infra-pre-build
      - lf-rtd-trigger-build:
          rtd-build-url: "{rtd-build-url}"
          rtd-token: "{rtd-token}"

- job-template:
    name: "{project-name}-rtd-merge-{stream}"
    id: gerrit-rtd-merge
    <<: *lf_rtd_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_rtd_merge

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on: "{obj:gerrit_merge_triggers}"
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project-pattern}"
              branches:
                - branch-compare-type: "ANT"
                  branch-pattern: "**/{branch}"
                - branch-compare-type: "ANT"
                  branch-pattern: "refs/tags/**"
              file-paths: "{obj:gerrit_trigger_file_paths}"

- job-template:
    name: "{project-name}-rtd-merge-{stream}"
    id: github-rtd-merge
    <<: *lf_rtd_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_rtd_merge

    properties:
      - lf-infra-properties:
          build-days-to-keep: "{build-days-to-keep}"
      - github:
          url: "{github-url}/{github-org}/{project}"

    triggers:
      - timed: "H H * * *"
      - github
      - pollscm:
          cron: ""
      - github-pull-request:
          trigger-phrase: "^remerge$"
          only-trigger-phrase: true
          status-context: "RTD Merge"
          permit-all: true
          github-hooks: true
          org-list:
            - "{github-org}"
          white-list: "{obj:github_pr_allowlist}"
          admin-list: "{obj:github_pr_admin_list}"
          included-regions: "{obj:github_included_regions}"
          white-list-target-branches:
            - "{branch}"

#############
# RTD VERIFY#
#############

- _lf_rtd_verify: &lf_rtd_verify
    name: lf-rtd-verify

    ######################
    # Default parameters #
    ######################

    branch: master
    build-days-to-keep: 7
    build-timeout: 15
    disable-job: false
    doc-dir: docs/_build/html
    git-url: "$GIT_URL/$PROJECT"
    github-url: "https://github.com"
    project-pattern: "**"
    python-version: python3
    stream: master
    submodule-recursive: true
    submodule-timeout: 10
    submodule-disable: false
    gerrit-skip-vote: false

    gerrit_verify_triggers:
      - patchset-created-event:
          exclude-drafts: true
          exclude-trivial-rebase: false
          exclude-no-code-change: false
      - draft-published-event
      - comment-added-contains-event:
          comment-contains-value: '^Patch Set\s+\d+:\s+(recheck|reverify)\s*$'

    #####################
    # Job Configuration #
    #####################

    disabled: "{disable-job}"

    builders:
      - lf-infra-pre-build
      - lf-rtd-verify:
          doc-dir: "{doc-dir}"
          python-version: "{python-version}"

- job-template:
    name: "{project-name}-rtd-verify-{stream}"
    id: gerrit-rtd-verify
    concurrent: true
    <<: *lf_rtd_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_rtd_verify

    scm:
      - lf-infra-gerrit-scm:
          branch: "$GERRIT_BRANCH"
          jenkins-ssh-credential: "{jenkins-ssh-credential}"
          git-url: "{git-url}"
          refspec: "" # Leave blank!! A later script will handle fetching
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          choosing-strategy: default

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on: "{obj:gerrit_verify_triggers}"
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project-pattern}"
              branches:
                - branch-compare-type: "ANT"
                  branch-pattern: "**/{branch}"
              file-paths: "{obj:gerrit_trigger_file_paths}"
          skip-vote:
            successful: "{gerrit-skip-vote}"
            failed: "{gerrit-skip-vote}"
            unstable: "{gerrit-skip-vote}"
            notbuilt: "{gerrit-skip-vote}"

- job-template:
    name: "{project-name}-rtd-verify-{stream}"
    id: github-rtd-verify
    concurrent: true
    <<: *lf_rtd_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_rtd_verify

    properties:
      - lf-infra-properties:
          build-days-to-keep: "{build-days-to-keep}"
      - github:
          url: "{github-url}/{github-org}/{project}"

    scm:
      - lf-infra-github-scm:
          url: "{git-clone-url}{github-org}/{project}"
          refspec: "+refs/pull/*:refs/remotes/origin/pr/*"
          branch: "$sha1"
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          choosing-strategy: default
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    triggers:
      - github-pull-request:
          trigger-phrase: "^(recheck|reverify)$"
          only-trigger-phrase: false
          status-context: "RTD Verify"
          permit-all: true
          github-hooks: true
          included-regions: "{obj:github_included_regions}"
          white-list-target-branches:
            - "{branch}"