X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=f21691297a0211476ad4c368c18e5cfa395f64b7;hb=e22b4ae0d41129f2910515c5fc25ff84fe63581b;hp=94fcb1c5449dffeeef707ca1276a258dce05eae3;hpb=2b811ee74f223040ff6071969566de72aed71b2a;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 94fcb1c5..f2169129 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 --------------------------- @@ -202,6 +222,27 @@ that want to use Maven. :mvn-version: Version of Maven to install. +lf-packagecloud-file-provider +----------------------------- + +Provisions files required by the Ruby gem package_cloud, namely +".packagecloud" and "packagecloud_api" in the Jenkins home directory. + +lf-packagecloud-push +-------------------- + +Pushes DEB/RPM package files to PackageCloud using the Ruby gem package_cloud. + +:Required parameters: + + :build-dir: Directory with deb/rpm files to push + :debian-distribution-versions: list of DEB package distro/version strings + separated by space; example: ubuntu/bionic debian/stretch + :packagecloud-account: PackageCloud account ID; example: oran + :packagecloud-repo: PackageCloud repository; example: master, staging + :rpm-distribution-versions: list of RPM package distro/version strings + separated by space; example: el/4 el/5 + lf-pip-install -------------- @@ -232,7 +273,42 @@ 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-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 +---------------- + +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,11 +327,59 @@ 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 ========== +lf-autotools-parameters +----------------------- + +Provides parameters needed by configure and make. Should be used by any jobs +that need to call the ``configure && make`` pattern. + lf-clm-parameters -------------------- +----------------- Provides the policy evaluation stage to run against Nexus IQ Server. Valid values include: 'build', 'stage-release', 'operate'. @@ -301,6 +425,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 +473,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 +489,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 ========