Merge "Add sigul signing to maven-stage job"

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

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 241ce12..c6334fd 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.
 
+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
 ---------------------
 
@@ -75,6 +95,11 @@ lf-infra-gpg-verify-git-signature
 Verify gpg signature of the latest commit message in $WORKSPACE.
 This command assumes that $WORKSPACE is a git repo.
 
+lf-infra-pre-build
+------------------
+
+Macro that runs before all builders to prepare the system for job use.
+
 lf-infra-package-listing
 ------------------------
 
@@ -162,27 +187,6 @@ Cleanup maven settings.xml configuration. This should be called at the end of
 any macros that calles the
 :ref:`lf-provide-maven-settings <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
 --------------------
 
@@ -193,13 +197,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
 -------------------------------
 
@@ -208,6 +216,18 @@ Forcibly removes all of the docker images.
 Parameters
 ==========
 
+lf-clm-parameters
+-------------------
+
+Provides the policy evaluation stage to run against Nexus IQ Server.
+Valid values include: 'build', 'stage-release', 'operate'.
+
+lf-cmake-parameters
+-------------------
+
+Provides parameters needed by CMake. Should be used by any jobs that need to
+call the ``cmake && make && make install`` pattern.
+
 lf-infra-maven-parameters
 -------------------------