X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=94fcb1c5449dffeeef707ca1276a258dce05eae3;hb=2b811ee74f223040ff6071969566de72aed71b2a;hp=58ec7930c3e14f5f4431e937ed38128698a884a4;hpb=ab9889f17775e4716a50ecbe879d8519b56c6976;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 58ec7930..94fcb1c5 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -95,6 +95,11 @@ lf-infra-gpg-verify-git-signature Verify gpg signature of the latest commit message in $WORKSPACE. This command assumes that $WORKSPACE is a git repo. +lf-infra-pre-build +------------------ + +Macro that runs before all builders to prepare the system for job use. + lf-infra-package-listing ------------------------ @@ -105,6 +110,14 @@ lf-infra-packer-build Run `packer build` to build system images. +:Required parameters: + + :openstack: Packer template uses an OpenStack builder (true|false). + :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter. + :packer-version: Version of packer to use. + :platform: Build platform as found in the vars directory. + :template: Packer template to build as found in the templates directory. + lf-infra-packer-validate ------------------------ @@ -112,6 +125,8 @@ Run `packer validate` to verify packer configuration. :Required parameters: + :openstack: Packer template uses an OpenStack builder (true|false). + :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter. :packer-cloud-settings: Cloud configuration file. Loaded on the build server as CLOUDENV environment variable. :packer-version: Version of packer to use. @@ -149,6 +164,33 @@ lf-jacoco-nojava-workaround Workaround for Jenkins not able to find Java in JaCoCo runs. +.. _lf-maven-central: + +lf-maven-central +---------------- + +Publish artifacts to OSSRH (Maven Central) staging. + +Requires that the project's settings.xml contains a ServerId 'ossrh' with the +credentials for the project's OSSRH account. + +This macro assumes the directory ``$WORKSPACE/m2repo`` contains a Maven 2 +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 + :language: yaml + +.. _lf-maven-install: + lf-maven-install ---------------- @@ -182,27 +224,6 @@ Cleanup maven settings.xml configuration. This should be called at the end of any macros that calles the :ref:`lf-provide-maven-settings ` macro. -.. _provide-sigul-config: - -lf-provide-sigul-configuration ------------------------------- - -Provides sigual configuration to the Jenkins build node. - -Requires the following Config File Provider managed files in Jenkins -preconfigured. - -* sigul-config -* sigul-password -* sigul-pki - -.. _provide-sigul-config-cleanup: - -lf-provide-sigul-configuration-cleanup --------------------------------------- - -Cleanup configuration provided by `provide-sigul-config`. - lf-rtd-trigger-build -------------------- @@ -213,13 +234,18 @@ lf-rtd-verify ReadTheDocs verify script. -lf-sigul-install ----------------- +lf-sigul-sign-dir +----------------- -Install Sigul. +Use Sigul to sign a directory via {sign-dir}. Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar. +:Required Parameters: + :sign-artifacts: Whether or not to sign artifacts with Sigul. + :sign-dir: Directory to sign. + :sign-mode: serial|parallel + lf-infra-provide-docker-cleanup ------------------------------- @@ -299,6 +325,12 @@ Provides basic lf-infra recommended publisher configurations which should be used in all job templates. This primary objective of this trigger is to gather build logs and copy them to a log server. +lf-infra-publish-windows +------------------------ + +Windows publisher for use at the end of Windows job templates. Takes care of +cleaning out the workspace at the end of a job. + SCM === @@ -307,6 +339,11 @@ lf-infra-gerrit-scm Basic SCM configuration for Gerrit based projects. +:Required parameters: + + :submodule-timeout: Timeout (in minutes) for checkout operation. + (default: 10) + lf-infra-github-scm ------------------- @@ -316,23 +353,41 @@ On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit` as the value. This will require that the job be triggered via the GHPRB plugin and not manually. +:Required parameters: + + :submodule-timeout: Timeout (in minutes) for checkout operation. + (default: 10) + Wrappers ======== +lf-infra-wrappers-common +------------------------ + +Provides lf-infra recommended wrappers which should be used in every +job-template. It's meant to be used by more specific wrappers below. + lf-infra-wrappers ----------------- Provides lf-infra recommended wrappers which should be used in every -job-template. +job-template that's run on Linux systems. -This wrapper requires that a managed file called `npmrc` exists in the Jenkins. The main use -case here is to point to a npm proxy, on Nexus for example. -The type of the file should be "Custom file". You can set various npmrc settings in it. -Documentation on npm configuration can be found at https://docs.npmjs.com/files/npmrc. -If you are not using npm then it is fine for the file to be empty. +This wrapper requires that a managed file called `npmrc` exists in the Jenkins. +The main use case here is to point to a npm proxy, on Nexus for example. +The type of the file should be "Custom file". You can set various npmrc +settings in it. Documentation on npm configuration can be found at +https://docs.npmjs.com/files/npmrc. If you are not using npm then it is fine +for the file to be empty. Example npmrc: .. code-block:: bash registry=https://nexus3.onap.org/repository/npm.public/ + +lf-infra-wrappers-windows +------------------------- + +Provides lf-infra recommended wrappers which should be used in every +job-template that's run on Windows systems.