Feat: Add CLI Sonar scanner job
[releng/global-jjb.git] / docs / jjb / lf-macros.rst
index 3d1b39e..0ad1506 100644 (file)
@@ -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.
 
+lf-ansible-config-file-provider
+-------------------------------
+
+Provisions files required by the ansible, namely
+"~/.ansible/ansible.cfg" in the Jenkins home directory.
 
 lf-fetch-dependent-patches
 --------------------------
@@ -374,6 +379,12 @@ Requires ``SonarQube Scanner for Jenkins``
     :sonar-java-opts: JVM options. (default: "")
     :sonar-additional-args: Additional command line arguments. (default: "")
 
+lf-infra-pipeline-verify
+------------------------
+
+Verify a Jenkins pipeline by linting it and ensuring that it cannot run on the
+Jenkins master.
+
 Parameters
 ==========
 
@@ -424,6 +435,11 @@ lf-infra-node-parameters
 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
 -----------------------
 
@@ -530,3 +546,10 @@ lf-infra-wrappers-windows
 
 Provides lf-infra recommended wrappers for use in every job-template targetting
 Windows systems.
+
+
+global-jjb-email-notification
+-----------------------------
+
+Provides a publisher macro that ties into the lf-openstack-cron job
+to alert admins if this job fails.