X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=9b9b0896298d5ce5a0ee2a562de9932536588a1f;hb=fc774967a7c4eba4b62811a21f083f2af5ff2570;hp=1d7a97b9524a0dddf6fd036436b95603c1b642c3;hpb=40874c69cc5fc00dcc73327af2a1a85bcff7d4d9;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 1d7a97b9..9b9b0896 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -5,6 +5,14 @@ Global Macros Builders ======== +comment-to-gerrit +----------------- + +This macro will post a comment to the gerrit patchset if the build +creates a file named gerrit_comment.txt +To use this macro add it to the list of builders. + + lf-fetch-dependent-patches -------------------------- @@ -118,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 ------------------------ @@ -159,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 --------------------------- @@ -180,6 +200,10 @@ repository which is to upload to OSSRH. :Required parameters: :mvn-central: Whether or not to upload to mvn-central. (true|false) + :mvn-global-settings: The name of the Maven global settings to use for + Maven configuration. (default: global-settings) + :mvn-settings: The name of settings file containing credentials for the + project. :ossrh-profile-id: Nexus staging profile ID as provided by OSSRH. .. literalinclude:: ../../.jjb-test/lf-macros/lf-maven-central-minimal.yaml @@ -228,7 +252,41 @@ Script to trigger a build on http://readthedocs.org lf-rtd-verify ------------- -ReadTheDocs verify script. +ReadTheDocs verify script. Installs and runs tox. + +:Required parameters: + + :doc-dir: Document directory. + :python-version: Python version. + +lf-rtdv2-build +--------------- + +ReadTheDocs Version 2 verify and merge scripts. +This is an update to the read the docs scripts that leverages the new Read the Docs v3 api +`RTD v3 API `_ +Runs tox to verify that the docs are good and then runs the RTDv2 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. + + +check-info-votes +---------------- + +Calls shell script to validate votes on a change to an INFO.yaml + +lf-release +---------- + +releases lftools.ini (required) +needed to push to nexus. + +[nexus] +username= +password= + +Then runs ../shell/release-job.sh + lf-sigul-sign-dir ----------------- @@ -247,6 +305,48 @@ lf-infra-provide-docker-cleanup Forcibly removes all of the docker images. +lf-infra-sonar +--------------- + +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: "") + Parameters ========== @@ -297,6 +397,12 @@ lf-infra-tox-parameters Provides parameters needed by python-tox. Should be used by any jobs that need to run `tox `. + +lf-build-with-parameters-maven-release +-------------------------------------- + +Provides parameters needed for maven release jobs 'build with parameters'. + Properties ========== @@ -339,6 +445,8 @@ Basic SCM configuration for Gerrit based projects. :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) lf-infra-github-scm ------------------- @@ -353,6 +461,8 @@ the GHPRB plugin and not manually. :submodule-timeout: Timeout (in minutes) for checkout operation. (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) Wrappers ========