jjb/doc/doc-templates-rtd.yaml

   1 ---
   2 - job-template:
   3     # Job template for verifying Sphinx/Restructured Text for RTD
   4     #
   5     # The purpose of this job template is verify documentation source
   6     #
   7     # Required Variables:
   8     #     branch:        git branch
   9     # Optional Variables:
  10     #     path:      directory containing the project's tox.ini relative to
  11     #                the workspace. The default is the project root.
  12
  13     name: '{project-name}-{stream}-verify-rtd'
  14     path: '$WORKSPACE'
  15
  16     project-type: freestyle
  17     concurrent: true
  18     node: '{build-node}'
  19
  20     properties:
  21       - infra-properties:
  22           build-days-to-keep: '{build-days-to-keep}'
  23
  24     parameters:
  25       - infra-parameters:
  26           project: '{project}'
  27           branch: '{branch}'
  28           refspec: 'refs/heads/{branch}'
  29           artifacts: '{archive-artifacts}'
  30       - maven-exec:
  31           maven-version: '{maven-version}'
  32
  33     scm:
  34       - git:
  35           credentials-id: '{jenkins-ssh-credential}'
  36           url: '$GIT_BASE'
  37           refspec: ''
  38           choosing-strategy: 'default'
  39           branches:
  40             - 'refs/heads/{branch}'
  41           skip-tag: true
  42           wipe-workspace: true
  43           submodule:
  44             recursive: '{submodule-recursive}'
  45             timeout: '24'
  46
  47     wrappers:
  48       - infra-wrappers:
  49           build-timeout: '{build-timeout}'
  50
  51     triggers:
  52       - gerrit-trigger-patch-submitted:
  53           server: '{server-name}'
  54           project: '**'
  55           branch: '{branch}'
  56           files: 'docs/**/*.rst'
  57       - timed: 'H H * * *'
  58
  59     builders:
  60       - shell: |
  61           if [ "$GERRIT_PROJECT" != "doc" ]; then
  62               if [ -d docs/submodules/$GERRIT_PROJECT.git ]; then
  63                   cd docs/submodules/$GERRIT_PROJECT.git
  64               else
  65                   cd docs/submodules/$GERRIT_PROJECT
  66               fi
  67               git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
  68           else
  69               git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
  70           fi
  71       - shell: !include-raw: doc-install-plantuml.sh
  72       - shell: |
  73           #!/bin/bash
  74           python3 -m venv $WORKSPACE/venv-tox
  75           source $WORKSPACE/venv-tox/bin/activate
  76           pip install --upgrade pip
  77           pip install --upgrade tox argparse
  78           pip freeze
  79           cd $WORKSPACE/{path}
  80           tox
  81           mkdir -p "$WORKSPACE/archives"
  82           mv  docs/_build/html "$WORKSPACE/archives/"
  83
  84     publishers:
  85       - infra-shiplogs:
  86           maven-version: '{maven-version}'
  87
  88 - job-template:
  89     # Job template for merging/publishing Sphinx/Restructured Text at RTD
  90     #
  91     # The purpose of this job template is to trigger updates after
  92     # a merge of documentation source in gerrit
  93     #
  94     # Required Variables:
  95     #     branch:        git branch
  96     #     rtdproject:    name of a project at readthedocs.io
  97     # Optional Variables:
  98     #     path:      directory containing the project's tox.ini relative to
  99     #                the workspace. The default is the project root.
 100
 101     name: '{project-name}-{stream}-merge-rtd'
 102     path: '$WORKSPACE'
 103
 104     project-type: freestyle
 105     concurrent: false
 106     node: '{build-node}'
 107
 108     properties:
 109       - infra-properties:
 110           build-days-to-keep: '{build-days-to-keep}'
 111
 112     parameters:
 113       - infra-parameters:
 114           project: '{project}'
 115           branch: '{branch}'
 116           refspec: 'refs/heads/{branch}'
 117           artifacts: '{archive-artifacts}'
 118       - maven-exec:
 119           maven-version: '{maven-version}'
 120
 121     scm:
 122       - git:
 123           credentials-id: '{jenkins-ssh-credential}'
 124           url: '$GIT_BASE'
 125           refspec: ''
 126           choosing-strategy: 'default'
 127           branches:
 128             - 'refs/heads/{branch}'
 129           skip-tag: true
 130           wipe-workspace: true
 131           submodule-recursive: '{submodule-recursive}'
 132
 133
 134     wrappers:
 135       - infra-wrappers:
 136           build-timeout: '{build-timeout}'
 137       - credentials-binding:
 138           - text:
 139              credential-id: docs-token
 140              variable: DOCS_RTD_TOKEN
 141
 142     triggers:
 143       - gerrit:
 144           server-name: '{server-name}'
 145           trigger-on:
 146             - change-merged-event
 147             - comment-added-contains-event:
 148                 comment-contains-value: 'remerge'
 149           projects:
 150             - project-compare-type: 'ANT'
 151               project-pattern: '**'
 152               branches:
 153                 - branch-compare-type: 'ANT'
 154                   branch-pattern: '**/{branch}'
 155               file-paths:
 156                 - compare-type: ANT
 157                   pattern: docs/**/*.rst
 158
 159     builders:
 160       - shell: !include-raw: doc-post-rtd.sh
 161
 162     publishers:
 163       - infra-shiplogs:
 164           maven-version: '{maven-version}'
 165