X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-python-jobs.rst;h=0244614189ecb43b97c2883109251feb62593b82;hb=e043053225eba25b3f6e502ad08fa459b9e9ef1e;hp=14f4274dc238739d5d0eb8c0a8dfd7956ce9b215;hpb=008d7f16e3784f03c60a4e425b064447efff210f;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst index 14f4274d..02446141 100644 --- a/docs/jjb/lf-python-jobs.rst +++ b/docs/jjb/lf-python-jobs.rst @@ -5,27 +5,45 @@ Python Jobs Job Groups ========== -{project-name}-python-jobs --------------------------- +.. include:: ../job-groups.rst -Jobs for Python projects using Gerrit. +Below is a list of Maven job groups: -:Includes: +.. literalinclude:: ../../jjb/lf-python-job-groups.yaml + :language: yaml - - gerrit-tox-verify -{project-name}-github-python-jobs ---------------------------------- +Macros +====== -Jobs for Python projects using GitHub. +lf-infra-clm-python +------------------- -:Includes: +Run CLM scanning against a Python project. - - github-tox-verify +:Required Parameters: + :clm-project-name: Project name in Nexus IQ to send results to. -Macros -====== +lf-infra-tox-install +-------------------- + +Install Tox into a virtualenv. + +:Required Parameters: + + :python-version: Version of Python to install into the Tox virtualenv. + Eg. python2 / python3 + +lf-infra-tox-sonar +------------------ + +Runs Sonar scanning against a Python project. + +:Required Parameters: + + :java-version: Version of Java to use to run Sonar. + :mvn-version: Version of Maven to use to run Sonar. lf-tox-install -------------- @@ -57,6 +75,8 @@ IQ Server. - gerrit-python-xc-clm - github-python-xc-clm +:Comment Trigger: run-clm + :Required parameters: :build-node: The node to run build on. @@ -66,15 +86,27 @@ IQ Server. :Optional parameters: :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :nexus-iq-cli-version: Nexus IQ CLI package version to download and use. (default: 1.44.0-01) - :build-timeout: Timeout in seconds before aborting build. (default: 60) + :nexus-iq-cli-version: Nexus IQ CLI package version to download and use. + (default: 1.44.0-01) + :nexus-iq-namespace: Insert a namespace to project AppID for projects that + share a Nexus IQ system to avoid project name collision. We recommend + inserting a trailing - dash if using this parameter. + For example 'odl-'. (default: '') + :build-timeout: Timeout in minutes before aborting build. (default: 60) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :java-version: Version of Java to use for the build. (default: openjdk8) :stream: Keyword used to represent 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) :gerrit_clm_triggers: Override Gerrit Triggers. + :gerrit_trigger_file_paths: Override file paths which used to filter which + file modifications will trigger a build. Refer to JJB documentation for + "file-path" details. + https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + Python Sonar with Tox --------------------- @@ -112,6 +144,8 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import - gerrit-tox-sonar - github-tox-sonar +:Comment Trigger: run-sonar + :Required parameters: :build-node: The node to run build on. @@ -122,7 +156,7 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import :Optional parameters: :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 60) + :build-timeout: Timeout in minutes before aborting build. (default: 60) :cron: Cron schedule when to trigger the job. This parameter also supports multiline input via YAML pipe | character in cases where one may want to provide more than 1 cron timer. (default: H 11 * * * @@ -136,7 +170,14 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import 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) :gerrit_sonar_triggers: Override Gerrit Triggers. + :gerrit_trigger_file_paths: Override file paths which used to filter which + file modifications will trigger a build. Refer to JJB documentation for + "file-path" details. + https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + Tox Verify ---------- @@ -157,6 +198,8 @@ following pyenv variables before running. - gerrit-tox-verify - github-tox-verify +:Comment Trigger: recheck|reverify + :Required Parameters: :build-node: The node to run build on. @@ -167,7 +210,7 @@ following pyenv variables before running. :branch: The branch to build against. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 10) + :build-timeout: Timeout in minutes before aborting build. (default: 10) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :python-version: Version of Python to configure as a base in virtualenv. (default: python3) @@ -175,8 +218,14 @@ following pyenv variables before running. 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) :tox-dir: Directory containing the project's tox.ini relative to the workspace. Empty works if tox.ini is at project root. (default: '') :tox-envs: Tox environments to run. If blank run everything described in tox.ini. (default: '') + :gerrit_trigger_file_paths: Override file paths which used to filter which + file modifications will trigger a build. Refer to JJB documentation for + "file-path" details. + https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit