1 .. _lf-global-jjb-rtd-jobs:
10 {project-name}-rtd-jobs
11 -----------------------
13 Jobs to deploy for a project producing ReadTheDocs using Gerrit.
20 {project-name}-github-rtd-jobs
21 ------------------------------
23 Jobs to deploy for a project producing ReadTheDocs using GitHub.
37 RTD verify and merge jobs are the same except for their scm, trigger, and
38 builders definition. This anchor is the common template.
47 Merge job which triggers a POST of the docs project to readthedocs.
49 To use this job first configure the ``Generic API incoming webhook`` in
50 ReadTheDocs. To do that follow these steps:
52 #. Browse to https://readthedocs.org/dashboard/PROJECT/integrations/
53 #. Click on ``Generic API incoming webhook``
57 If not available click on ``Add integration`` and add the
58 ``Generic API incoming webhook``.
60 #. Copy the custom webhook URL, this is your ``rtd-build-url``
62 For example: https://readthedocs.org/api/v2/webhook/opendaylight/32321/
64 #. Copy the token, this is your ``rtd-token``
67 - {project-name}-rtd-merge-{stream}
71 :Comment Trigger: remerge
75 :build-node: The node to run build on.
76 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
78 :rtd-build-url: This is the generic webhook url from readthedocs.org. Refer
79 to the above instructions to generate one.
80 (Check Admin > Integrations > Generic API incoming webhook)
81 :rtd-token: The unique token for the project Generic webhook. Refer
82 to the above instructions to generate one.
83 (Check Admin > Integrations > Generic API incoming webhook)
87 :branch: Git branch to fetch for the build. (default: master)
88 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
89 :build-timeout: Timeout in minutes before aborting build. (default: 15)
90 :git-url: base URL of git project. (default: https://github.com)
91 :project-pattern: Project to trigger build against. (default: \*\*)
92 :stream: Keyword representing a release code-name.
93 Often the same as the branch. (default: master)
94 :submodule-recursive: Whether to checkout submodules recursively.
97 :gerrit_merge_triggers: Override Gerrit Triggers.
98 :gerrit_trigger_file_paths: Override file paths filter which checks which
99 file modifications will trigger a build.
105 pattern: '**/conf.py'
111 Verify job which runs a tox build of the docs project
114 - {project-name}-rtd-verify-{stream}
118 :Comment Trigger: recheck|reverify
120 :Required Parameters:
122 :build-node: The node to run build on.
123 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
126 :Optional Parameters:
128 :branch: Git branch to fetch for the build. (default: master)
129 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
130 :build-node: The node to run build on.
131 :build-timeout: Timeout in minutes before aborting build. (default: 15)
132 :doc-dir: Directory where tox will place built docs.
133 as defined in the tox.ini (default: docs/_build/html)
134 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
135 :project-pattern: Project to trigger build against. (default: \*\*)
136 :stream: Keyword representing a release code-name.
137 Often the same as the branch. (default: master)
138 :submodule-recursive: Whether to checkout submodules recursively.
141 :gerrit_verify_triggers: Override Gerrit Triggers.
142 :gerrit_trigger_file_paths: Override file paths filter which checks which
143 file modifications will trigger a build.
149 pattern: '**/conf.py'