jjb/docs.yaml

---
# CORD documentation verification and publish tasks

- project:
    name: verify-docs-legacy

    # add repos that have documentation to the project list in both jobs
    jobs:
      - 'verify-documentation-legacy':
          project-regexp: '^(cord|platform-install|cord-tester|rcord|ecord|mcord|opencloud|xos|xos-gui|xos-tosca)$'
          branch-regexp: '{supported-branches-regexp}'

- project:
    name: verify-docs

    # add repos that have documentation to the project list in both jobs
    jobs:
      - 'verify-documentation':
          primary-docs-repo-regexp: '^docs$'
          other-docs-repos-regexp: '^(cord-tester|xos|xos-gui|xos-tosca)$'
          branch-regexp: '{modern-branches-regexp}'

- project:
    name: publish-docs

    jobs:
      - 'publish-documentation':
          project-regexp: '^(cord|platform-install|cord-tester|rcord|ecord|mcord|opencloud|xos|xos-gui|xos-tosca)$'
          branch-regexp: '{supported-branches-regexp}'

# Documentation job templates
- job-template:
    id: verify-documentation-legacy
    name: "verify-documentation-legacy"

    triggers:
      - cord-infra-gerrit-trigger-patchset:
          gerrit-server-name: '{gerrit-server-name}'
          project-regexp: '{project-regexp}'
          branch-regexp: '{branch-regexp}'
          file-include-regexp: '{doc-files-regexp}'
          dependency-jobs: '{dependency-jobs}'

    properties:
      - cord-infra-properties:
          build-days-to-keep: '{build-days-to-keep}'
          artifact-num-to-keep: '{artifact-num-to-keep}'

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

    scm:
      - cord-infra-gerrit-repo-scm:
          manifest-url: '{gerrit-server-url}/{cord-repo-manifest}'
          branch: '$GERRIT_BRANCH'
          destination-dir: 'cord'

    node: '{build-node}'
    project-type: freestyle
    concurrent: false

    builders:
      - cord-infra-gerrit-repo-patch:
          destination-dir: 'cord'
          project: '$GERRIT_PROJECT'
          change-number: '$GERRIT_CHANGE_NUMBER'
          patchset-number: '$GERRIT_PATCHSET_NUMBER'
      - shell: |
          cd cord/build/docs
          make test

- job-template:
    id: verify-documentation
    name: "verify-documentation"

    triggers:
      # trigger on any change in docs repo
      - cord-infra-gerrit-trigger-patchset:
          gerrit-server-name: '{gerrit-server-name}'
          project-regexp: '{primary-docs-repo-regexp}'
          branch-regexp: '{branch-regexp}'
          file-include-regexp: '{all-files-regexp}'
          dependency-jobs: '{dependency-jobs}'
      # trigger on only docs/* changes in other repos
      - cord-infra-gerrit-trigger-patchset:
          gerrit-server-name: '{gerrit-server-name}'
          project-regexp: '{other-docs-repos-regexp}'
          branch-regexp: '{branch-regexp}'
          file-include-regexp: '{doc-files-regexp}'
          dependency-jobs: '{dependency-jobs}'

    properties:
      - cord-infra-properties:
          build-days-to-keep: '{build-days-to-keep}'
          artifact-num-to-keep: '{artifact-num-to-keep}'

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

    scm:
      - cord-infra-gerrit-repo-scm:
          manifest-url: '{gerrit-server-url}/{cord-repo-manifest}'
          branch: '$GERRIT_BRANCH'
          destination-dir: 'cord'

    node: '{build-node}'
    project-type: freestyle
    concurrent: false

    builders:
      - cord-infra-gerrit-repo-patch:
          destination-dir: 'cord'
          project: '$GERRIT_PROJECT'
          change-number: '$GERRIT_CHANGE_NUMBER'
          patchset-number: '$GERRIT_PATCHSET_NUMBER'
      - shell: |
          cd cord/docs
          make test

- job-template:
    id: publish-documentation
    name: 'publish-documentation'

    triggers:
      - cord-infra-gerrit-trigger-merge:
          gerrit-server-name: '{gerrit-server-name}'
          project-regexp: '{project-regexp}'
          branch-regexp: '{branch-regexp}'
          file-include-regexp: '{doc-files-regexp}'
          dependency-jobs: '{dependency-jobs}'

    properties:
      - cord-infra-properties:
          build-days-to-keep: '{build-days-to-keep}'
          artifact-num-to-keep: '{artifact-num-to-keep}'

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

    scm:
      - cord-infra-gerrit-repo-scm:
          manifest-url: '{gerrit-server-url}/{cord-repo-manifest}'
          branch: '$GERRIT_BRANCH'
          destination-dir: 'cord'

    node: '{build-node}'
    project-type: freestyle
    concurrent: false

    builders:
      - shell: |
          cd cord/build/docs
          make build

# publish over ssh: https://docs.openstack.org/infra/jenkins-job-builder/publishers.html#publishers.ssh
    publishers:
      - ssh:
          site: 'CORD Wiki'
          source: 'cord/build/docs/_book/**'
          remove-prefix: 'cord/build/docs/_book'
          target: '//var/www/guide/$GERRIT_BRANCH'
      - ssh:
          site: 'CORD Wiki'
          source: 'cord/build/docs/xos/swagger/**'
          remove-prefix: 'cord/build/docs/xos'
          target: '//var/www/guide/$GERRIT_BRANCH'