X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=1ab522cb3430f6ed250c24b21a16cc2f6706bb65;hb=bbaf6b55269a0cb6fb129af73d82c2efd6d83bcf;hp=724dad65f5d5489afcfa8f45f5126c838c7444b6;hpb=f90d002be64f126671ebe3a48d9af4add1ded6c1;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 724dad65..1ab522cb 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -16,6 +16,26 @@ called DEPENDENCY_BUILD_ORDER which can be used if necessary to build projects in the specified order. The order is determined by first patch instance for a project in the patch list. +lf-license-check +---------------- + +Checks files for + +:Required parameters: + + :file-patterns: Space-separated list of file patterns to scan. + For example: \*.go \*.groovy \*.java \*.py \*.sh + :spdx-disable: Disable the SPDX-Identifier checker. + :lhc-version: Version of LHC to use. + :license-exclude-paths: Comma-separated list of paths to exclude from the + license checker. The paths used here will be matched using a contains + rule so it is best to be as precise with the path as possible. + For example a path of '/src/generated/' will be searched as + '**/src/generated/**'. + Example: org/opendaylight/yang/gen,protobuff/messages + :licenses-allowed: Comma-separated list of allowed licenses. + For example: Apache-2.0,EPL-1.0,MIT + lf-infra-create-netrc --------------------- @@ -91,6 +111,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 ------------------ @@ -149,6 +187,11 @@ lf-rtd-verify ReadTheDocs verify script. +lf-infra-provide-docker-cleanup +------------------------------- + +Forcibly removes all of the docker images. + Parameters ========== @@ -218,14 +261,6 @@ 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 -======== - -lf-infra-github-pr-trigger --------------------------- - -Provides configuration for a GitHub PR Trigger. - Wrappers ========