3 # Job template for verifying Sphinx/Restructured Text for RTD
5 # The purpose of this job template is verify documentation source
10 # path: directory containing the project's tox.ini relative to
11 # the workspace. The default is the project root.
13 name: '{project-name}-{stream}-verify-rtd'
16 project-type: freestyle
22 build-days-to-keep: '{build-days-to-keep}'
28 refspec: 'refs/heads/{branch}'
29 artifacts: '{archive-artifacts}'
31 maven-version: '{maven-version}'
35 credentials-id: '{jenkins-ssh-credential}'
38 choosing-strategy: 'default'
40 - 'refs/heads/{branch}'
44 recursive: '{submodule-recursive}'
49 build-timeout: '{build-timeout}'
52 - gerrit-trigger-patch-submitted:
53 server: '{server-name}'
56 files: 'docs/**/*.rst'
61 if [ "$GERRIT_PROJECT" != "doc" ]; then
62 if [ -d docs/submodules/$GERRIT_PROJECT.git ]; then
63 cd docs/submodules/$GERRIT_PROJECT.git
65 cd docs/submodules/$GERRIT_PROJECT
67 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
69 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
71 - shell: !include-raw: doc-install-plantuml.sh
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
81 mkdir -p "$WORKSPACE/archives"
82 mv docs/_build/html "$WORKSPACE/archives/"
88 # Job template for merging/publishing Sphinx/Restructured Text at RTD
90 # The purpose of this job template is to trigger updates after
91 # a merge of documentation source in gerrit
95 # rtdproject: name of a project at readthedocs.io
97 # path: directory containing the project's tox.ini relative to
98 # the workspace. The default is the project root.
100 name: '{project-name}-{stream}-merge-rtd'
103 project-type: freestyle
109 build-days-to-keep: '{build-days-to-keep}'
115 refspec: 'refs/heads/{branch}'
116 artifacts: '{archive-artifacts}'
118 maven-version: '{maven-version}'
122 credentials-id: '{jenkins-ssh-credential}'
125 choosing-strategy: 'default'
127 - 'refs/heads/{branch}'
130 submodule-recursive: '{submodule-recursive}'
135 build-timeout: '{build-timeout}'
136 - credentials-binding:
138 credential-id: docs-token
139 variable: DOCS_RTD_TOKEN
143 server-name: '{server-name}'
145 - change-merged-event
146 - comment-added-contains-event:
147 comment-contains-value: 'remerge'
149 - project-compare-type: 'ANT'
150 project-pattern: '**'
152 - branch-compare-type: 'ANT'
153 branch-pattern: '**/{branch}'
156 pattern: docs/**/*.rst
159 - shell: !include-raw: doc-post-rtd.sh