Fix: Update lf-infra-sonar macro to use JDK version

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

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 955e224..112fd2f 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
 --------------------------


@@ -127,7 +132,6 @@ Run `packer build` to build system images.
     :packer-version: Version of packer to use.
     :platform: Build platform as found in the vars directory.
     :template: Packer template to build as found in the templates directory.
     :packer-version: Version of packer to use.
     :platform: Build platform as found in the vars directory.
     :template: Packer template to build as found in the templates directory.

-    :packer-builder: builder type to use. ex: aws, openstack (default: openstack)

 
 :Optional parameters:
 
 
 :Optional parameters:
 


@@ -146,7 +150,6 @@ Run ``packer validate`` to verify packer configuration.
     :packer-cloud-settings: Cloud configuration file. Loaded on the build
         server as CLOUDENV environment variable.
     :packer-version: Version of packer to use.
     :packer-cloud-settings: Cloud configuration file. Loaded on the build
         server as CLOUDENV environment variable.
     :packer-version: Version of packer to use.

-    :packer-builder: builder type to use. ex: aws, openstack (default: openstack)

 
 lf-infra-push-gerrit-patch
 --------------------------
 
 lf-infra-push-gerrit-patch
 --------------------------


@@ -351,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
 ---------------------------


@@ -432,6 +436,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
 -----------------------