X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;ds=inline;f=docs%2Fjjb%2Flf-macros.rst;h=34f9e964b95d00046fd08ed83fd302d4a9182b67;hb=9fdb611f1;hp=ce7ac0d246bfdd33d988387c4eff12a60da3d64d;hpb=603bc6bed1996d666f34ec88b06d9c3dfc69d090;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index ce7ac0d2..34f9e964 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -315,6 +315,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 ------------------- @@ -324,23 +329,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.