X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=3df86ab2a765ca6f35ca7bbb5e8623a217566a30;hb=31a4b7fc00fe90494b6efb512ad0f1db02481ff3;hp=e628179dac02916f66806b69e020bd61c5861925;hpb=4028ad2bc487460837736f040d885c3674b39031;p=releng%2Fglobal-jjb.git

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index e628179d..3df86ab2 100644
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -44,6 +44,11 @@ Checks files for
     :licenses-allowed: Comma-separated list of allowed licenses.
         For example: Apache-2.0,EPL-1.0,MIT
 
+lf-infra-capture-instance-metadata
+----------------------------------
+
+Capture instance metadata.
+
 lf-infra-create-netrc
 ---------------------
 
@@ -222,6 +227,27 @@ that want to use Maven.
 
     :mvn-version: Version of Maven to install.
 
+lf-packagecloud-file-provider
+-----------------------------
+
+Provisions files required by the Ruby gem package_cloud, namely
+".packagecloud" and "packagecloud_api" in the Jenkins home directory.
+
+lf-packagecloud-push
+--------------------
+
+Pushes DEB/RPM package files to PackageCloud using the Ruby gem package_cloud.
+
+:Required parameters:
+
+    :build-dir: Directory with deb/rpm files to push
+    :debian-distribution-versions: list of DEB package distro/version strings
+        separated by space; example: ubuntu/bionic debian/stretch
+    :packagecloud-account: PackageCloud account ID; example: oran
+    :packagecloud-repo: PackageCloud repository; example: master, staging
+    :rpm-distribution-versions: list of RPM package distro/version strings
+        separated by space; example: el/4 el/5
+
 lf-pip-install
 --------------
 
@@ -259,6 +285,18 @@ ReadTheDocs verify script. Installs and runs tox.
     :doc-dir: Document directory.
     :python-version: Python version.
 
+lf-rtdv3-build
+---------------
+
+Read the docs scripts that leverage the new Read the Docs v3 api
+`RTD v3 API <https://docs.readthedocs.io/en/stable/api/v3.html>`_
+Runs tox to verify that the docs are good and then runs the RTDv3 shell script.
+This script handles creating projects as needed, assiging subprojects to the main
+read the docs project and triggering builds to update the documentation.
+Jobs will run but skip verify bits until a .readthedocs.yaml is found in the root
+of their repository.
+
+
 check-info-votes
 ----------------
 
@@ -301,8 +339,37 @@ Runs Jenkins SonarQube plug-in.
 
 Requires ``SonarQube Scanner for Jenkins``
 
+.. note:: Sonar properties can be set directly in the job definition by
+   setting the sonar-project-file to ``""`` and adding all properties under
+   ``sonar-properties``.
+
 :Optional Parameters:
     :sonar-task: Sonar task to run. (default: "")
+    :sonar-project-file: The filename for the project's properties
+        (default: "sonar-project.properties")
+    :sonar-properties: Sonar configuration properties. (default: "")
+    :sonar-java-opts: JVM options. (default: "")
+    :sonar-additional-args: Additional command line arguments. (default: "")
+
+lf-infra-sonar-with-prescan
+---------------------------
+
+Runs Jenkins SonarQube plug-in after a pre-scan builder, which is defined by
+the macro's caller.
+
+Requires ``SonarQube Scanner for Jenkins``
+
+.. note:: Sonar properties can be set directly in the job definition by
+   setting the sonar-project-file to ``""`` and adding all properties under
+   ``sonar-properties``.
+
+:Required Parameters:
+    :lf-sonar-prescan: A builder that will run prior to the Sonar scan.
+
+:Optional Parameters:
+    :sonar-task: Sonar task to run. (default: "")
+    :sonar-project-file: The filename for the project's properties
+        (default: "sonar-project.properties")
     :sonar-properties: Sonar configuration properties. (default: "")
     :sonar-java-opts: JVM options. (default: "")
     :sonar-additional-args: Additional command line arguments. (default: "")
@@ -310,8 +377,14 @@ Requires ``SonarQube Scanner for Jenkins``
 Parameters
 ==========
 
+lf-autotools-parameters
+-----------------------
+
+Provides parameters needed by configure and make. Should be used by any jobs
+that need to call the ``configure && make`` pattern.
+
 lf-clm-parameters
--------------------
+-----------------
 
 Provides the policy evaluation stage to run against Nexus IQ Server.
 Valid values include: 'build', 'stage-release', 'operate'.
@@ -385,7 +458,8 @@ lf-infra-publish
 
 Provides basic lf-infra recommended publisher configurations which should be
 used in all job templates. This primary objective of this trigger is to
-gather build logs and copy them to a log server.
+gather package listing, instance metadata, sar reports, build logs and copy
+them to a log server.
 
 lf-infra-publish-windows
 ------------------------