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 58ec793..c6334fd 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -95,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
 ------------------------
 
@@ -182,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
 --------------------
 
@@ -213,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
 -------------------------------