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 # :rtd-project: This is the name of the project on ReadTheDocs.org.
79 # Optional parameters:
81 # :branch: Git branch to fetch for the build. (default: master)
82 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
83 # :build-node: The node to run build on.
84 # :build-timeout: Timeout in seconds before aborting build. (default: 15)
85 # :git-url: base URL of git project. (default: https://github.com)
86 # :project-pattern: Project to trigger build against. (default: **)
87 # :stream: Keyword that can be used to represent a release code-name.
88 # Often the same as the branch. (default: master)
90 ######################
91 # Default parameters #
92 ######################
97 git-url: https://github.com
100 submodule-recursive: true
102 #####################
103 # Job Configuration #
104 #####################
107 - lf-rtd-trigger-build:
108 rtd-project: '{rtd-project}'
111 name: '{project-name}-rtd-merge-{stream}'
114 # yamllint disable-line rule:key-duplicates
119 server-name: '{gerrit-server-name}'
121 - change-merged-event
122 - comment-added-contains-event:
123 comment-contains-value: 'remerge$'
125 - project-compare-type: 'ANT'
126 project-pattern: '{project-pattern}'
128 - branch-compare-type: 'ANT'
129 branch-pattern: '**/{branch}'
130 file-paths: '{obj:gerrit_trigger_file_paths}'
133 name: '{project-name}-rtd-merge-{stream}'
136 # yamllint disable-line rule:key-duplicates
141 url: '{git-url}/{github-org}/{project}'
144 - lf-infra-github-pr-trigger:
145 trigger-phrase: '^remerge$'
146 only-trigger-phrase: false
147 status-context: 'RTD Merge'
153 github_pr_admin_list:
161 - lf_rtd_verify: &lf_rtd_verify
163 # Verify job which runs a tox build of the docs project
165 # Optional parameters:
167 # :branch: Git branch to fetch for the build. (default: master)
168 # :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
169 # :build-node: The node to run build on.
170 # :build-timeout: Timeout in seconds before aborting build. (default: 15)
171 # :doc-dir: Directory where tox will place built docs.
172 # as defined in the tox.ini (default: docs/_build/html)
173 # :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
174 # :project-pattern: Project to trigger build against. (default: **)
175 # :stream: Keyword that can be used to represent a release code-name.
176 # Often the same as the branch. (default: master)
177 # :submodule-recursive: Whether to checkout submodules recursively.
180 # :gerrit_verify_triggers: Override Gerrit Triggers.
181 # :gerrit_trigger_file_paths: Override file paths which can be used to
182 # filter which file modifications will trigger a build.
183 # (default: - compare-type: ANT
184 # pattern: '**/*.rst'
185 # - compare-type: ANT
186 # pattern: '**/conf.py')
188 ######################
189 # Default parameters #
190 ######################
193 build-days-to-keep: 7
195 doc-dir: docs/_build/html
196 git-url: '$GIT_URL/$PROJECT'
197 project-pattern: '**'
199 submodule-recursive: true
201 gerrit_verify_triggers:
202 - patchset-created-event:
203 exclude-drafts: false
204 exclude-trivial-rebase: false
205 exclude-no-code-change: false
206 - draft-published-event
207 - comment-added-contains-event:
208 comment-contains-value: recheck$
210 #####################
211 # Job Configuration #
212 #####################
219 name: '{project-name}-rtd-verify-{stream}'
220 id: gerrit-rtd-verify
223 # yamllint disable-line rule:key-duplicates
227 - lf-infra-gerrit-scm:
229 jenkins-ssh-credential: '{jenkins-ssh-credential}'
232 submodule-recursive: '{submodule-recursive}'
233 choosing-strategy: default
237 server-name: '{gerrit-server-name}'
238 trigger-on: '{obj:gerrit_verify_triggers}'
240 - project-compare-type: 'ANT'
241 project-pattern: '{project-pattern}'
243 - branch-compare-type: 'ANT'
244 branch-pattern: '**/{branch}'
245 file-paths: '{obj:gerrit_trigger_file_paths}'
248 name: '{project-name}-rtd-verify-{stream}'
249 id: github-rtd-verify
252 # yamllint disable-line rule:key-duplicates
257 url: '{git-url}/{github-org}/{project}'
260 - lf-infra-github-scm:
261 url: '{git-clone-url}{github-org}/{project}'
262 refspec: '+refs/pull/*:refs/remotes/origin/pr/*'
264 submodule-recursive: '{submodule-recursive}'
265 choosing-strategy: default
266 jenkins-ssh-credential: '{jenkins-ssh-credential}'
269 - lf-infra-github-pr-trigger:
270 trigger-phrase: '^recheck$'
271 only-trigger-phrase: false
272 status-context: 'RTD Verify'
278 github_pr_admin_list: