X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=35727e505f6f6cf7cdca9f62b85610626cb02bd5;hb=7584bc78fd4abc218105f122b58be667f2cd00d4;hp=d6e5f1432ea1e78516fe1320d072a98ec7269925;hpb=2e09a8efe9497d2253810c2523047abf0253c8e9;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index d6e5f143..35727e50 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -25,6 +25,13 @@ Create a ~/.netrc file from a Maven settings.xml :server-id: The id of a server as defined in settings.xml. +:Optional parameters: + + :ALT_NEXUS_SERVER: URL of custom nexus server. + If set this will take precedence. + Use this to point at nexus3.$PROJECTDOMAIN + for example. + lf-infra-deploy-maven-file -------------------------- @@ -84,6 +91,24 @@ Run `packer validate` to verify packer configuration. server as CLOUDENV environment variable. :packer-version: Version of packer to use. +lf-infra-push-gerrit-patch +-------------------------- + +Push a change through a Jenkins job to a Gerrit repository in an automated +way using git-review. + +:Required parameters: + + :gerrit-commit-message: Commit message to assign. + :gerrit-host: Gerrit hostname. + :gerrit-topic: Gerrit topic. + :gerrit-user: Gerrit user-id used for submitting the change. + :reviewers-email: Reviewers email. Space-separated list of + email addresses to CC on the patch. + :project: Gerrit project name. + +.. _lf-infra-ship-logs: + lf-infra-ship-logs ------------------ @@ -118,7 +143,7 @@ Call pip install to install packages into a virtualenv located in .. note:: The first package listed in PIP_PACKAGES is used as the VENV name. -.. _lf-provide-maven-settings +.. _lf-provide-maven-settings: lf-provide-maven-settings ------------------------- @@ -142,6 +167,11 @@ lf-rtd-verify ReadTheDocs verify script. +lf-infra-provide-docker-cleanup +------------------------------- + +Forcibly removes all of the docker images. + Parameters ========== @@ -207,6 +237,10 @@ lf-infra-github-scm Basic SCM configuration for GitHub based projects. +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. + Triggers ======== @@ -223,3 +257,15 @@ lf-infra-wrappers Provides lf-infra recommended wrappers which should be used in every job-template. + +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/