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.
12 # pattern: ant file-path pattern relative to the workspace used to
15 name: '{project-name}-{stream}-verify-rtd'
18 project-type: freestyle
24 build-days-to-keep: '{build-days-to-keep}'
30 refspec: 'refs/heads/{branch}'
31 artifacts: '{archive-artifacts}'
33 maven-version: '{maven-version}'
37 refspec: '$GERRIT_REFSPEC'
38 choosing-strategy: 'gerrit'
39 submodule-recursive: '{submodule-recursive}'
43 build-timeout: '{build-timeout}'
46 - gerrit-trigger-patch-submitted:
47 server: '{server-name}'
50 files: 'docs/**/*.rst'
55 if [ "$GERRIT_PROJECT" != "doc" ]; then
56 cd docs/submodules/$GERRIT_PROJECT
57 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
59 git fetch origin $GERRIT_REFSPEC && git checkout FETCH_HEAD
63 virtualenv $WORKSPACE/venv-tox
64 source $WORKSPACE/venv-tox/bin/activate
65 pip install --upgrade pip
66 pip install --upgrade tox argparse
73 maven-version: '{maven-version}'
76 # Job template for merging/publishing Sphinx/Restructured Text at RTD
78 # The purpose of this job template is to trigger updates after
79 # a merge of documentation source in gerrit
83 # rtdproject: name of a project at readthedocs.io
85 # path: directory containing the project's tox.ini relative to
86 # the workspace. The default is the project root.
87 # pattern: ant file-path pattern relative to the workspace used to
90 name: '{project-name}-{stream}-merge-rtd'
93 project-type: freestyle
99 build-days-to-keep: '{build-days-to-keep}'
105 refspec: 'refs/heads/{branch}'
106 artifacts: '{archive-artifacts}'
108 maven-version: '{maven-version}'
111 - gerrit-trigger-scm:
112 refspec: '$GERRIT_REFSPEC'
113 choosing-strategy: 'gerrit'
114 submodule-recursive: '{submodule-recursive}'
118 build-timeout: '{build-timeout}'
122 server-name: '{server-name}'
124 - change-merged-event
125 - comment-added-contains-event:
126 comment-contains-value: 'remerge'
128 - project-compare-type: 'ANT'
129 project-pattern: '**'
131 - branch-compare-type: 'ANT'
132 branch-pattern: '**/{branch}'
135 pattern: docs/**/*.rst
138 - shell: !include-raw: doc-post-rtd.sh
142 maven-version: '{maven-version}'