1 .. _lf-global-jjb-rtdv3-jobs:
3 ##########################
4 ReadTheDocs Version:3 Jobs
5 ##########################
7 ReadTheDocs V3 jobs support documentation that is structured as a
8 master documentation project plus a sub-project for each software
9 component. The master project files are usually maintained in a
10 "docs" git repository and should contain an index with links to all
11 the sub-projects. Each sub-project must maintain its documentation
12 files in a "docs" subdirectory within that software component's git
15 The RTDv3 Jenkins jobs publish documentation by triggering builds at
16 ReadTheDocs.io. That build process clones the appropriate repository
17 and transforms Real Simple Text (RST) and other files into HTML.
18 Master project builds are performed separately from sub-project
21 The ReadTheDocs site supports multiple versions of documentation for
22 the master project and every sub-project. Every project should have a
23 development branch that's published at ReadTheDocs under the title
24 "latest"; in git this is usually the "master" branch. Most projects
25 also declare releases periodically. ReadTheDocs automatically detects
26 the creation of git branches and git tags, and publishes the most
27 recent one under the title "stable." For more details please see
29 <https://docs.readthedocs.io/en/stable/versions.html>`_. Teams can
30 control this process using Jenkins job configuration parameters as
36 To transform your rst documentation into a read the docs page, this job must be
37 configured and created as described in Admin setup below. Once this is complete
38 the following files must be added to your repository:
50 docs/requirements-docs.txt
53 Rather than have you copy and paste these files from a set of docs here, the
54 following repo contains a script that will do this for you. Please refer to the
55 explanation presented in: https://github.com/lfit-sandbox/test. This is all
56 currently a beta feature, so feedback is encouraged. The script
57 `docs_script.sh` is not needed, you can copy the files by hand if you prefer.
59 The default location of the tox.ini file is in the git repository root
60 directory. Optionally your documentation lead may decide to store all tox files
61 within the required "docs" subdirectory by setting configuration option
62 "tox-dir" to value "docs/" as discussed below.
64 If your project's tox dir is "docs/" and not "." the tox.ini must be
65 reconfigured with the correct relative paths.
67 Once these files are correctly configured in your repository you can test
72 tox -e docs,docs-linkcheck
75 Stable Branch Instructions
76 --------------------------
78 If your project does not create branches, you can skip this step.
79 Once you branch your project modify your conf.yaml and add the following line:
83 version: 'ReleaseBranchName'
85 This will update the docs and change "master" on the top bar to your branch
86 name. This change should be done against your release branch, this change will
87 trigger a Read The Docs build which will create a new landing point for your
90 This landing point is called /stable/ and is selectable as a version in the
91 bottom right corner of all Read The Docs pages. Once all projects have
92 branched and modified their conf.py they will have available their /stable/
93 documentation. The process to release the documentation (that is to change the
94 default landing point of your docs from /latest/ to /stable/) is to change the
95 default-version in the jenkins job config as follows:
101 default-version: latest
107 default-version: ReleaseBranchName
112 This is a global job that only needs to be added once to your project's ci-mangement git
113 repository. It leverages the read the docs v3 api to create projects on the fly, as well
114 as setting up subproject associations with the master doc.
116 Jobs will run but skip any actual verification until a .readthedocs.yaml is placed in the
117 root of the repository
119 The master doc must be defined in
120 jenkins-config/global-vars-{production|sandbox}.sh
122 Normally this project is called doc or docs or documentation and all other docs build will
123 be set as a subproject of this job.
129 global-vars-sandbox.sh:
130 MASTER_RTD_PROJECT=doc-test
131 global-vars-production.sh:
132 MASTER_RTD_PROJECT=doc
134 In this way sandbox jobs will create docs with a test suffix and will not stomp on production
139 example file: ci-management/jjb/rtd/rtd.yaml
145 name: rtdv3-global-verify
146 build-node: centos7-builder-1c-1g
147 default-version: latest
150 - rtdv3-global-verify
155 branch: stable/{stream}
158 name: rtdv3-global-merge
159 default-version: latest
160 build-node: centos7-builder-1c-1g
167 branch: stable/{stream}
169 Or add both jobs via a job group:
177 default-version: latest
179 build-node: centos7-builder-1c-1g
187 Github jobs must be per project, and will be covered by a diffrent set of jobs once these are proven.
189 Job requires an lftools config section, this is to provide api access to read the docs.
194 endpoint = https://readthedocs.org/api/v3/
197 Merge Job will create a project on read the docs if none exist.
198 Merge Job will assign a project as a subproject of the master project.
199 Merge job will trigger a build to update docs.
200 Merge job will change the default version if needed.
208 RTD verify and merge jobs are the same except for their scm, trigger, and
209 builders definition. This anchor is the common template.
218 Merge job which triggers a build of the docs to readthedocs.
221 - rtdv3-global-merge-{stream}
223 :Comment Trigger: remerge
225 :Required parameters:
227 :build-node: The node to run build on.
228 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
231 :Optional parameters:
233 :branch: Git branch to fetch for the build. (default: master)
234 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
235 :build-timeout: Timeout in minutes before aborting build. (default: 15)
236 :default-version: default page to redirect to for documentation (default /latest/)
237 :disable-job: Whether to disable the job (default: false)
238 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
239 :project-pattern: Project to trigger build against. (default: \*\*)
240 :stream: Keyword representing a release code-name.
241 Often the same as the branch. (default: master)
242 :submodule-recursive: Whether to checkout submodules recursively.
244 :submodule-timeout: Timeout (in minutes) for checkout operation.
246 :submodule-disable: Disable submodule checkout operation.
249 :gerrit_merge_triggers: Override Gerrit Triggers.
250 :gerrit_trigger_file_paths: Override file paths filter which checks which
251 file modifications will trigger a build.
254 - compare-type: REG_EXP
258 ReadTheDocs v3 Verify
259 ---------------------
261 Verify job which runs a tox build of the docs project.
262 Also outputs some info on the build.
265 - rtdv3-global-verify-{stream}
267 :Comment Trigger: recheck|reverify
269 :Required Parameters:
271 :build-node: The node to run build on.
272 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
275 :Optional Parameters:
277 :branch: Git branch to fetch for the build. (default: master)
278 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
279 :build-timeout: Timeout in minutes before aborting build. (default: 15)
280 :gerrit-skip-vote: Skip voting for this job. (default: false)
281 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
282 :disable-job: Whether to disable the job (default: false)
283 :project-pattern: Project to trigger build against. (default: \*\*)
284 :stream: Keyword representing a release code-name.
285 Often the same as the branch. (default: master)
286 :submodule-recursive: Whether to checkout submodules recursively.
288 :submodule-timeout: Timeout (in minutes) for checkout operation.
290 :submodule-disable: Disable submodule checkout operation.
292 :tox-dir: Directory containing the project's read the docs tox.ini
293 :gerrit_verify_triggers: Override Gerrit Triggers.
294 :gerrit_trigger_file_paths: Override file paths filter which checks which
295 file modifications will trigger a build.
298 - compare-type: REG_EXP