X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=9f35594ff7bf606cb88b7af0a98f2f662fa620e0;hb=d6b1f4b40c6f8e6bb056f90c59bdbdbb549046d9;hp=69873c9193a76859806eb69cbfb0868efd50a183;hpb=d8e3dc493b1ba8b5a462887c6fa90a51c86bedc2;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 69873c91..9f35594f 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -195,27 +195,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 -------------------- @@ -226,13 +205,17 @@ 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. + lf-infra-provide-docker-cleanup ------------------------------- @@ -312,6 +295,18 @@ 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-stack-delete +--------------- + +Requirements: + +* lftools >= v0.17.0 + +Delete an openstack heat stack. Use at the end of a job that creates a stack. + +This macro requires a parameter defined in the job named STACK_NAME +containing the name of the stack to delete. + SCM === @@ -332,20 +327,33 @@ the GHPRB plugin and not manually. 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.