X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-rtd-jobs.rst;h=393d091719433ddabd7f6155e67a27424fcb05e0;hb=766dbef8a63d824d6e551d4f179806521be95d13;hp=780fd626534e856f69f2839efce69d29efcee1a4;hpb=c13d28098ddc544908b2c8d5a04d485c47f4e579;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-rtd-jobs.rst b/docs/jjb/lf-rtd-jobs.rst index 780fd626..393d0917 100644 --- a/docs/jjb/lf-rtd-jobs.rst +++ b/docs/jjb/lf-rtd-jobs.rst @@ -7,25 +7,12 @@ ReadTheDocs Jobs 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 @@ -68,6 +55,8 @@ ReadTheDocs. To do that follow these steps: - gerrit-rtd-merge - github-rtd-merge +:Comment Trigger: remerge + :Required parameters: :build-node: The node to run build on. @@ -84,13 +73,17 @@ ReadTheDocs. To do that follow these steps: :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 15) + :build-timeout: Timeout in minutes before aborting build. (default: 15) :git-url: base URL of git project. (default: https://github.com) :project-pattern: Project to trigger build against. (default: \*\*) :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_merge_triggers: Override Gerrit Triggers. :gerrit_trigger_file_paths: Override file paths filter which checks which @@ -106,13 +99,15 @@ ReadTheDocs. To do that follow these steps: 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. @@ -124,15 +119,21 @@ Verify job which runs a tox build of the docs project :branch: Git branch to fetch for the build. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) :build-node: The node to run build on. - :build-timeout: Timeout in seconds before aborting build. (default: 15) + :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