Add license check job using new lhc

[releng/global-jjb.git] / docs / jjb / lf-macros.rst

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index a5da00d..1ab522c 100644 (file)
--- 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.
 
 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
 ---------------------
 
 lf-infra-create-netrc
 ---------------------
 


@@ -25,6 +45,13 @@ Create a ~/.netrc file from a Maven settings.xml
 
     :server-id: The id of a server as defined in 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
 --------------------------
 
 lf-infra-deploy-maven-file
 --------------------------
 


@@ -84,6 +111,24 @@ Run `packer validate` to verify packer configuration.
         server as CLOUDENV environment variable.
     :packer-version: Version of packer to use.
 
         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
 ------------------
 
 lf-infra-ship-logs
 ------------------
 


@@ -118,7 +163,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.
 
 
 .. 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
 -------------------------
 
 lf-provide-maven-settings
 -------------------------


@@ -142,6 +187,11 @@ lf-rtd-verify
 
 ReadTheDocs verify script.
 
 
 ReadTheDocs verify script.
 

+lf-infra-provide-docker-cleanup
+-------------------------------
+
+Forcibly removes all of the docker images.
+

 Parameters
 ==========
 
 Parameters
 ==========
 


@@ -211,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.
 
 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
 ========
 
 Wrappers
 ========