X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=a653bc559278e965b082ca80330faf9abe5f1ecb;hb=49914d6b5bc5f50ed1592ee72ad9d62fa68ed3f4;hp=94fcb1c5449dffeeef707ca1276a258dce05eae3;hpb=f50130f8bd687b514716a1300453c9fd70cfca99;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 94fcb1c5..a653bc55 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 -------------------------- @@ -232,7 +240,30 @@ 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. + +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 ----------------- @@ -251,6 +282,19 @@ 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`` + +:Optional Parameters: + :sonar-task: Sonar task to run. (default: "") + :sonar-properties: Sonar configuration properties. (default: "") + :sonar-java-opts: JVM options. (default: "") + :sonar-additional-args: Additional command line arguments. (default: "") + Parameters ========== @@ -301,6 +345,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 ========== @@ -343,6 +393,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 ------------------- @@ -357,6 +409,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 ========