3 name: '{project-name}-rtd-jobs'
5 # This job group contains all the ReadTheDocs jobs
12 name: '{project-name}-github-rtd-jobs'
14 # This job group contains all the ReadTheDocs jobs
24 - lf_rtd_common: &lf_rtd_common
26 # RTD verify and merge jobs are the same except for their scm, trigger, and
27 # builders definition. This anchor is the common template.
29 ######################
30 # Default parameters #
31 ######################
33 gerrit_trigger_file_paths:
43 project-type: freestyle
47 - lf-infra-properties:
51 - lf-infra-parameters:
54 refspec: 'refs/heads/{branch}'
56 lftools-version: '{lftools-version}'
60 build-timeout: '{build-timeout}'
61 jenkins-ssh-credential: '{jenkins-ssh-credential}'
70 - lf_rtd_merge: &lf_rtd_merge
73 # Merge job which triggers a POST of the docs project to readthedocs
75 # Required parameters:
77 # :build-node: The node to run build on.
78 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
79 # be configured in defaults.yaml)
80 # :rtd-project: This is the name of the project on ReadTheDocs.org.
82 # Optional parameters:
84 # :branch: Git branch to fetch for the build. (default: master)
85 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
86 # :build-timeout: Timeout in seconds before aborting build. (default: 15)
87 # :git-url: base URL of git project. (default: https://github.com)
88 # :project-pattern: Project to trigger build against. (default: **)
89 # :stream: Keyword that can be used to represent a release code-name.
90 # Often the same as the branch. (default: master)
91 # :submodule-recursive: Whether to checkout submodules recursively.
94 # :gerrit_merge_triggers: Override Gerrit Triggers.
95 # :gerrit_trigger_file_paths: Override file paths which can be used to
96 # filter which file modifications will trigger a build.
97 # (default: - compare-type: ANT
100 # pattern: '**/conf.py')
102 ######################
103 # Default parameters #
104 ######################
107 build-days-to-keep: 7
109 git-url: https://github.com
110 project-pattern: '**'
112 submodule-recursive: true
114 gerrit_merge_triggers:
115 - change-merged-event
116 - comment-added-contains-event:
117 comment-contains-value: remerge$
119 #####################
120 # Job Configuration #
121 #####################
124 - lf-rtd-trigger-build:
125 rtd-project: '{rtd-project}'
128 name: '{project-name}-rtd-merge-{stream}'
131 # yamllint disable-line rule:key-duplicates
136 server-name: '{gerrit-server-name}'
137 trigger-on: '{obj:gerrit_merge_triggers}'
139 - project-compare-type: 'ANT'
140 project-pattern: '{project-pattern}'
142 - branch-compare-type: 'ANT'
143 branch-pattern: '**/{branch}'
144 file-paths: '{obj:gerrit_trigger_file_paths}'
147 name: '{project-name}-rtd-merge-{stream}'
150 # yamllint disable-line rule:key-duplicates
155 url: '{git-url}/{github-org}/{project}'
158 - lf-infra-github-pr-trigger:
159 trigger-phrase: '^remerge$'
160 only-trigger-phrase: false
161 status-context: 'RTD Merge'
167 github_pr_admin_list:
175 - lf_rtd_verify: &lf_rtd_verify
177 # Verify job which runs a tox build of the docs project
179 # Required Parameters:
181 # :build-node: The node to run build on.
182 # :jenkins-ssh-credential: Credential to use for SSH. (Generally should
183 # be configured in defaults.yaml)
185 # Optional Parameters:
187 # :branch: Git branch to fetch for the build. (default: master)
188 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
189 # :build-node: The node to run build on.
190 # :build-timeout: Timeout in seconds before aborting build. (default: 15)
191 # :doc-dir: Directory where tox will place built docs.
192 # as defined in the tox.ini (default: docs/_build/html)
193 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
194 # :project-pattern: Project to trigger build against. (default: **)
195 # :stream: Keyword that can be used to represent a release code-name.
196 # Often the same as the branch. (default: master)
197 # :submodule-recursive: Whether to checkout submodules recursively.
200 # :gerrit_verify_triggers: Override Gerrit Triggers.
201 # :gerrit_trigger_file_paths: Override file paths which can be used to
202 # filter which file modifications will trigger a build.
203 # (default: - compare-type: ANT
204 # pattern: '**/*.rst'
205 # - compare-type: ANT
206 # pattern: '**/conf.py')
208 ######################
209 # Default parameters #
210 ######################
213 build-days-to-keep: 7
215 doc-dir: docs/_build/html
216 git-url: '$GIT_URL/$PROJECT'
217 project-pattern: '**'
219 submodule-recursive: true
221 gerrit_verify_triggers:
222 - patchset-created-event:
224 exclude-trivial-rebase: false
225 exclude-no-code-change: false
226 - draft-published-event
227 - comment-added-contains-event:
228 comment-contains-value: recheck$
230 #####################
231 # Job Configuration #
232 #####################
239 name: '{project-name}-rtd-verify-{stream}'
240 id: gerrit-rtd-verify
243 # yamllint disable-line rule:key-duplicates
247 - lf-infra-gerrit-scm:
248 branch: '$GERRIT_BRANCH'
249 jenkins-ssh-credential: '{jenkins-ssh-credential}'
251 refspec: '' # Leave blank!! A later script will handle fetching
252 submodule-recursive: '{submodule-recursive}'
253 choosing-strategy: default
257 server-name: '{gerrit-server-name}'
258 trigger-on: '{obj:gerrit_verify_triggers}'
260 - project-compare-type: 'ANT'
261 project-pattern: '{project-pattern}'
263 - branch-compare-type: 'ANT'
264 branch-pattern: '**/{branch}'
265 file-paths: '{obj:gerrit_trigger_file_paths}'
268 name: '{project-name}-rtd-verify-{stream}'
269 id: github-rtd-verify
272 # yamllint disable-line rule:key-duplicates
277 url: '{git-url}/{github-org}/{project}'
280 - lf-infra-github-scm:
281 url: '{git-clone-url}{github-org}/{project}'
282 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
284 submodule-recursive: '{submodule-recursive}'
285 choosing-strategy: default
286 jenkins-ssh-credential: '{jenkins-ssh-credential}'
289 - lf-infra-github-pr-trigger:
290 trigger-phrase: '^recheck$'
291 only-trigger-phrase: false
292 status-context: 'RTD Verify'
298 github_pr_admin_list: