Job Groups
==========
-{project-name}-rtd-jobs
------------------------
+.. include:: ../job-groups.rst
-Jobs to deploy for a project producing ReadTheDocs using Gerrit.
+Below is a list of Maven job groups:
-:Includes:
-
- - gerrit-rtd-merge
- - gerrit-rtd-verify
-
-{project-name}-github-rtd-jobs
-------------------------------
-
-Jobs to deploy for a project producing ReadTheDocs using GitHub.
-
-:Includes:
-
- - github-rtd-merge
- - github-rtd-verify
+.. literalinclude:: ../../jjb/lf-rtd-job-groups.yaml
+ :language: yaml
Macros
- gerrit-rtd-merge
- github-rtd-merge
+:Comment Trigger: remerge
+
:Required parameters:
:build-node: The node to run build on.
Often the same as the branch. (default: master)
:submodule-recursive: Whether to checkout submodules recursively.
(default: true)
+ :submodule-timeout: Timeout (in minutes) for checkout operation.
+ (default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_merge_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths filter which checks which
ReadTheDocs Verify
------------------
-Verify job which runs a tox build of the docs project
+Verify job which runs tox to test the docs project
:Template Names:
- {project-name}-rtd-verify-{stream}
- gerrit-rtd-verify
- github-rtd-verify
+:Comment Trigger: recheck|reverify
+
:Required Parameters:
:build-node: The node to run build on.
:build-timeout: Timeout in minutes before aborting build. (default: 15)
:doc-dir: Directory where tox will place built docs.
as defined in the tox.ini (default: docs/_build/html)
+ :gerrit-skip-vote: Skip voting for this job. (default: false)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:project-pattern: Project to trigger build against. (default: \*\*)
+ :python-version: Python version (default: python2)
:stream: Keyword representing a release code-name.
Often the same as the branch. (default: master)
:submodule-recursive: Whether to checkout submodules recursively.
(default: true)
+ :submodule-timeout: Timeout (in minutes) for checkout operation.
+ (default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths filter which checks which