8 {project-name}-rtd-jobs
9 -----------------------
11 Jobs to deploy for a project producing ReadTheDocs using Gerrit.
18 {project-name}-github-rtd-jobs
19 ------------------------------
21 Jobs to deploy for a project producing ReadTheDocs using GitHub.
35 RTD verify and merge jobs are the same except for their scm, trigger, and
36 builders definition. This anchor is the common template.
45 Merge job which triggers a POST of the docs project to readthedocs
48 - {project-name}-rtd-merge-{stream}
54 :build-node: The node to run build on.
55 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
57 :rtd-project: This is the name of the project on ReadTheDocs.org.
61 :branch: Git branch to fetch for the build. (default: master)
62 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
63 :build-timeout: Timeout in seconds before aborting build. (default: 15)
64 :git-url: base URL of git project. (default: https://github.com)
65 :project-pattern: Project to trigger build against. (default: \*\*)
66 :stream: Keyword representing a release code-name.
67 Often the same as the branch. (default: master)
68 :submodule-recursive: Whether to checkout submodules recursively.
71 :gerrit_merge_triggers: Override Gerrit Triggers.
72 :gerrit_trigger_file_paths: Override file paths filter which checks which
73 file modifications will trigger a build.
85 Verify job which runs a tox build of the docs project
88 - {project-name}-rtd-verify-{stream}
94 :build-node: The node to run build on.
95 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
100 :branch: Git branch to fetch for the build. (default: master)
101 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
102 :build-node: The node to run build on.
103 :build-timeout: Timeout in seconds before aborting build. (default: 15)
104 :doc-dir: Directory where tox will place built docs.
105 as defined in the tox.ini (default: docs/_build/html)
106 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
107 :project-pattern: Project to trigger build against. (default: \*\*)
108 :stream: Keyword representing a release code-name.
109 Often the same as the branch. (default: master)
110 :submodule-recursive: Whether to checkout submodules recursively.
113 :gerrit_verify_triggers: Override Gerrit Triggers.
114 :gerrit_trigger_file_paths: Override file paths filter which checks which
115 file modifications will trigger a build.
121 pattern: '**/conf.py'