X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=f3eae1beb3d7d34c292cf3f2062ef07c6951c56c;hb=refs%2Fchanges%2F03%2F62103%2F7;hp=a653bc559278e965b082ca80330faf9abe5f1ecb;hpb=12eace1d1f832e2c42147ac7826c87670ec0cc0c;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index a653bc55..f3eae1be 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -126,6 +126,11 @@ Run `packer build` to build system images. :platform: Build platform as found in the vars directory. :template: Packer template to build as found in the templates directory. +:Optional parameters: + + :update-cloud-image: Submit a change request to update new built cloud + image to Jenkins. + lf-infra-packer-validate ------------------------ @@ -167,6 +172,13 @@ lf-infra-sysstat Retrieves system stats. +lf-infra-update-packer-images +----------------------------- + +Find and update the new built cloud image{s} in the ci-management source +repository. + + lf-jacoco-nojava-workaround --------------------------- @@ -247,6 +259,18 @@ ReadTheDocs verify script. Installs and runs tox. :doc-dir: Document directory. :python-version: Python version. +lf-rtdv3-build +--------------- + +Read the docs scripts that leverage the new Read the Docs v3 api +`RTD v3 API `_ +Runs tox to verify that the docs are good and then runs the RTDv3 shell script. +This script handles creating projects as needed, assiging subprojects to the main +read the docs project and triggering builds to update the documentation. +Jobs will run but skip verify bits until a .readthedocs.yaml is found in the root +of their repository. + + check-info-votes ---------------- @@ -289,8 +313,37 @@ Runs Jenkins SonarQube plug-in. Requires ``SonarQube Scanner for Jenkins`` +.. note:: Sonar properties can be set directly in the job definition by + setting the sonar-project-file to ``""`` and adding all properties under + ``sonar-properties``. + +:Optional Parameters: + :sonar-task: Sonar task to run. (default: "") + :sonar-project-file: The filename for the project's properties + (default: "sonar-project.properties") + :sonar-properties: Sonar configuration properties. (default: "") + :sonar-java-opts: JVM options. (default: "") + :sonar-additional-args: Additional command line arguments. (default: "") + +lf-infra-sonar-with-prescan +--------------------------- + +Runs Jenkins SonarQube plug-in after a pre-scan builder, which is defined by +the macro's caller. + +Requires ``SonarQube Scanner for Jenkins`` + +.. note:: Sonar properties can be set directly in the job definition by + setting the sonar-project-file to ``""`` and adding all properties under + ``sonar-properties``. + +:Required Parameters: + :lf-sonar-prescan: A builder that will run prior to the Sonar scan. + :Optional Parameters: :sonar-task: Sonar task to run. (default: "") + :sonar-project-file: The filename for the project's properties + (default: "sonar-project.properties") :sonar-properties: Sonar configuration properties. (default: "") :sonar-java-opts: JVM options. (default: "") :sonar-additional-args: Additional command line arguments. (default: "")