Fix: Address RTDv3.sh documentation job failures

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

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 1ea2cfa..c4bda39 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -12,6 +12,11 @@ This macro will post a comment to the gerrit patchset if the build
 creates a file named gerrit_comment.txt
 To use this macro add it to the list of builders.
 
 creates a file named gerrit_comment.txt
 To use this macro add it to the list of builders.
 

+lf-ansible-config-file-provider
+-------------------------------
+
+Provisions files required by the ansible, namely
+"~/.ansible/ansible.cfg" in the Jenkins home directory.

 
 lf-fetch-dependent-patches
 --------------------------
 
 lf-fetch-dependent-patches
 --------------------------


@@ -349,6 +354,7 @@ Requires ``SonarQube Scanner for Jenkins``
     :sonar-properties: Sonar configuration properties. (default: "")
     :sonar-java-opts: JVM options. (default: "")
     :sonar-additional-args: Additional command line arguments. (default: "")
     :sonar-properties: Sonar configuration properties. (default: "")
     :sonar-java-opts: JVM options. (default: "")
     :sonar-additional-args: Additional command line arguments. (default: "")

+    :sonar-jdk: JDK version to use. (default: openjdk17)

 
 lf-infra-sonar-with-prescan
 ---------------------------
 
 lf-infra-sonar-with-prescan
 ---------------------------


@@ -401,6 +407,14 @@ lf-cmake-parameters
 Provides parameters required by CMake. Use in any jobs that need to call the
 ``cmake && make && make install`` pattern.
 
 Provides parameters required by CMake. Use in any jobs that need to call the
 ``cmake && make && make install`` pattern.
 

+lf-gerrit-event-comment-text-parameter
+--------------------------------------
+
+Provides the value for GERRIT_EVENT_COMMENT_TEXT,
+needed for jobs triggerable via a gerrit comment
+when starting them via "Build with parameters" instead.
+For example when testing jobs on Sandbox.
+

 lf-infra-maven-parameters
 -------------------------
 
 lf-infra-maven-parameters
 -------------------------
 


@@ -430,6 +444,11 @@ lf-infra-node-parameters
 Provides parameters needed by NodeJS and NPM. Use in any jobs that need to run
 NodeJS or NPM.
 
 Provides parameters needed by NodeJS and NPM. Use in any jobs that need to run
 NodeJS or NPM.
 

+lf-infra-sonar-cli-parameters
+-----------------------------
+
+Provides parameters needed by Python jobs to run the SonarCloud CLI.
+

 lf-infra-tox-parameters
 -----------------------
 
 lf-infra-tox-parameters
 -----------------------