X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-python-jobs.rst;h=fde103df5252a2f523b742a1ddde3d98a429575e;hb=6b413898e59824dede32428a4b7231e1824c7a59;hp=0f02b428b4faeb7be3725e3a9cc055a472749b22;hpb=ca2ec8e82f3cdc1eb355f1aa29a968002ec3c9e6;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst index 0f02b428..fde103df 100644 --- a/docs/jjb/lf-python-jobs.rst +++ b/docs/jjb/lf-python-jobs.rst @@ -43,8 +43,11 @@ Creates a Tox virtual environment and invokes tox. :Required Parameters: - :parallel: Boolean. If true use detox (distributed tox); - else use regular tox. + :parallel: If different from false, try pass this parameter to tox option + "--parallel" to parallelize jobs in the envlist (and then activate the + option "--parallel-live" to display output in logs). + Possible values are "auto" (equivalent to "true" for legacy), + "all" or any integer. Any other value is equivalent to "false". Job Templates @@ -102,7 +105,7 @@ does not support multi-branch. :gerrit_nexusiq_triggers: Override Gerrit Triggers. :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :github-url: URL for Github. (default: https://github.com) - :java-version: Version of Java to use for the scan. (default: openjdk8) + :java-version: Version of Java to use for the scan. (default: openjdk11) :nexus-iq-cli-version: Nexus IQ CLI package version to download and use. (default is a string like 1.89.0-02, see file lf-python-jobs.yaml) :nexus-iq-namespace: Insert a namespace to project AppID for projects that @@ -196,11 +199,15 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import :disable-job: Whether to disable the job (default: false) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :github-url: URL for Github. (default: https://github.com) - :java-version: Version of Java to use for the build. (default: openjdk8) + :java-version: Version of Java to use for the build. (default: openjdk11) :mvn-global-settings: The name of the Maven global settings to use :mvn-goals: The Maven goal to run first. (default: validate) :mvn-version: Version of maven to use. (default: mvn35) - :parallel: Boolean indicator for tox to run tests in parallel or series. + :parallel: If different from false, try pass this parameter to tox option + "--parallel" to parallelize jobs in the envlist (and then activate the + option "--parallel-live" to display output in logs). + Possible values are "auto" (equivalent to "true" for legacy), + "all" or any integer. Any other value is equivalent to "false". (default: false, in series) :pre-build-script: Shell script to execute before the Sonar builder. For example, install prerequisites or move files to the repo root. @@ -230,7 +237,7 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import :gerrit_sonar_triggers: Override Gerrit Triggers. :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit .. comment Stop ignoring @@ -291,7 +298,11 @@ Plug-in configurations :disable-job: Whether to disable the job (default: false) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) :github-url: URL for Github. (default: https://github.com) - :parallel: Boolean indicator for tox to run tests in parallel or series. + :parallel: If different from false, try pass this parameter to tox option + "--parallel" to parallelize jobs in the envlist (and then activate the + option "--parallel-live" to display output in logs). + Possible values are "auto" (equivalent to "true" for legacy), + "all" or any integer. Any other value is equivalent to "false". (default: false, in series) :pre-build-script: Shell script to run before tox. Useful for setting up dependencies. (default: a string with a shell comment) @@ -401,8 +412,12 @@ variables before running. :pre-build-script: Shell script to execute before the Tox builder. For example, install prerequisites or move files to the repo root. (default: a string with a shell comment) - :parallel: Boolean indicator for tox to run tests in parallel or series. - (default: false, in series) + :parallel: If different from false, try pass this parameter to tox option + "--parallel" to parallelize jobs in the envlist (and then activate the + option "--parallel-live" to display output in logs). + Possible values are "auto" (equivalent to "true" for legacy), + "all" or any integer. Any other value is equivalent to "false". + (default: false, in series) :python-version: Python version to invoke pip install of tox-pyenv (default: python2) :stream: Keyword representing a release code-name. @@ -420,7 +435,7 @@ variables before running. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit Tox Merge @@ -479,7 +494,7 @@ variables before running. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit PyPI Merge @@ -568,8 +583,12 @@ is optional, it defaults to pypi.org. :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '') :mvn-params: Parameters to pass to the mvn CLI. (default: '') :mvn-version: Version of maven to use. (default: mvn35) - :parallel: Boolean indicator for tox to run tests in parallel or series. - (default: false, in series) + :parallel: If different from false, try pass this parameter to tox option + "--parallel" to parallelize jobs in the envlist (and then activate the + option "--parallel-live" to display output in logs). + Possible values are "auto" (equivalent to "true" for legacy), + "all" or any integer. Any other value is equivalent to "false". + (default: false, in series) :pre-build-script: Shell script to execute before the tox builder. For example, install system prerequisites. (default: a shell comment) :pypi-repo: Key for the PyPI target repository in the .pypirc file, @@ -591,7 +610,7 @@ is optional, it defaults to pypi.org. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit PyPI Stage @@ -680,8 +699,12 @@ is optional, it defaults to pypi.org. :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '') :mvn-params: Parameters to pass to the mvn CLI. (default: '') :mvn-version: Version of maven to use. (default: mvn35) - :parallel: Boolean indicator for tox to run tests in parallel or series. - (default: false, in series) + :parallel: If different from false, try pass this parameter to tox option + "--parallel" to parallelize jobs in the envlist (and then activate the + option "--parallel-live" to display output in logs). + Possible values are "auto" (equivalent to "true" for legacy), + "all" or any integer. Any other value is equivalent to "false". + (default: false, in series) :pre-build-script: Shell script to execute before the tox builder. For example, install system prerequisites. (default: a shell comment) :pypi-repo: Key for the PyPI target repository in the .pypirc file, @@ -703,7 +726,7 @@ is optional, it defaults to pypi.org. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit PyPI Verify ----------- @@ -796,8 +819,12 @@ pyenv variables before running. :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '') :mvn-params: Parameters to pass to the mvn CLI. (default: '') :mvn-version: Version of maven to use. (default: mvn35) - :parallel: Boolean indicator for tox to run tests in parallel or series. - (default: false, in series) + :parallel: If different from false, try pass this parameter to tox option + "--parallel" to parallelize jobs in the envlist (and then activate the + option "--parallel-live" to display output in logs). + Possible values are "auto" (equivalent to "true" for legacy), + "all" or any integer. Any other value is equivalent to "false". + (default: false, in series) :pre-build-script: Shell script to execute before the tox builder. For example, install system prerequisites. (default: a shell comment) :python-version: Python version to invoke pip install of tox-pyenv @@ -817,4 +844,4 @@ pyenv variables before running. in tox.ini. (default: '') :gerrit_trigger_file_paths: Override file paths used to filter which file modifications trigger a build. Refer to JJB documentation for "file-path" details. - https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit