1 .. _lf-global-jjb-rtdv2-jobs:
3 ##########################
4 ReadTheDocs Version:2 Jobs
5 ##########################
7 This is a global job that only needs to be added once to your project's ci-mangement git repository. It leverages the read the docs v3 api to create projects on the fly, as well as set up subproject associations with the master doc.
9 The master doc must be defined in
10 jenkins-config/global-vars-{production|sandbox}.sh
13 global-vars-sandbox.sh:
14 MASTER_RTD_PROJECT=doc-test
15 global-vars-production.sh:
16 MASTER_RTD_PROJECT=doc
18 In this way sandbox jobs will create docs with a test suffix and will not stomp on production documentation.
22 example file: ci-management/jjb/rtd/rtd.yaml
28 name: rtdv2-verify-global
29 build-node: centos7-builder-1c-1g
36 branch: stable/{stream}
39 name: rtdv2-merge-global
40 build-node: centos7-builder-1c-1g
47 branch: stable/{stream}
49 Or add both jobs via a job group:
57 build-node: centos7-builder-1c-1g
65 Github jobs must be per project, and will be covered by a diffrent set of jobs once these are proven.
67 Job requires an lftools config section, this is to provide api access to read the docs.
72 endpoint = https://readthedocs.org/api/v3/
75 Merge Job will create a project on read the docs if none exist.
76 Merge Job will assign a project as a subproject of the master project.
77 Merge job will trigger a build to update docs.
85 RTD verify and merge jobs are the same except for their scm, trigger, and
86 builders definition. This anchor is the common template.
95 Merge job which triggers a build of the docs to readthedocs.
98 - rtdv2-merge-global-{stream}
100 :Comment Trigger: remerge
102 :Required parameters:
104 :build-node: The node to run build on.
105 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
108 :Optional parameters:
110 :branch: Git branch to fetch for the build. (default: master)
111 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
112 :build-timeout: Timeout in minutes before aborting build. (default: 15)
113 :project-pattern: Project to trigger build against. (default: \*\*)
114 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
115 :disable-job: Whether to disable the job (default: false)
116 :stream: Keyword representing a release code-name.
117 Often the same as the branch. (default: master)
118 :submodule-recursive: Whether to checkout submodules recursively.
120 :submodule-timeout: Timeout (in minutes) for checkout operation.
122 :submodule-disable: Disable submodule checkout operation.
125 :gerrit_merge_triggers: Override Gerrit Triggers.
126 :gerrit_trigger_file_paths: Override file paths filter which checks which
127 file modifications will trigger a build.
130 - compare-type: REG_EXP
132 - compare-type: REG_EXP
134 - compare-type: REG_EXP
136 - compare-type: REG_EXP
137 pattern: '.*\/conf.py'
141 ReadTheDocs v2 Verify
142 ---------------------
144 Verify job which runs a tox build of the docs project.
145 Also outputs some info on the build
148 - rtdv2-verify-global-{stream}
150 :Comment Trigger: recheck|reverify
152 :Required Parameters:
154 :build-node: The node to run build on.
155 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
158 :Optional Parameters:
160 :branch: Git branch to fetch for the build. (default: master)
161 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
162 :build-timeout: Timeout in minutes before aborting build. (default: 15)
163 :gerrit-skip-vote: Skip voting for this job. (default: false)
164 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
165 :disable-job: Whether to disable the job (default: false)
166 :project-pattern: Project to trigger build against. (default: \*\*)
167 :stream: Keyword representing a release code-name.
168 Often the same as the branch. (default: master)
169 :submodule-recursive: Whether to checkout submodules recursively.
171 :submodule-timeout: Timeout (in minutes) for checkout operation.
173 :submodule-disable: Disable submodule checkout operation.
176 :gerrit_verify_triggers: Override Gerrit Triggers.
177 :gerrit_trigger_file_paths: Override file paths filter which checks which
178 file modifications will trigger a build.
181 - compare-type: REG_EXP
183 - compare-type: REG_EXP
185 - compare-type: REG_EXP
187 - compare-type: REG_EXP
188 pattern: '.*\/conf.py'