Add sonar-prescan jobs

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

diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 9f35594..0f8fd20 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -5,6 +5,14 @@ Global Macros
 Builders
 ========
 
 Builders
 ========
 

+comment-to-gerrit
+-----------------
+
+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-fetch-dependent-patches
 --------------------------
 
 lf-fetch-dependent-patches
 --------------------------
 


@@ -125,6 +133,8 @@ Run `packer validate` to verify packer configuration.
 
 :Required parameters:
 
 
 :Required parameters:
 

+    :openstack: Packer template uses an OpenStack builder (true|false).
+    :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.

     :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.


@@ -162,6 +172,33 @@ lf-jacoco-nojava-workaround
 
 Workaround for Jenkins not able to find Java in JaCoCo runs.
 
 
 Workaround for Jenkins not able to find Java in JaCoCo runs.
 

+.. _lf-maven-central:
+
+lf-maven-central
+----------------
+
+Publish artifacts to OSSRH (Maven Central) staging.
+
+Requires that the project's settings.xml contains a ServerId 'ossrh' with the
+credentials for the project's OSSRH account.
+
+This macro assumes the directory ``$WORKSPACE/m2repo`` contains a Maven 2
+repository which is to upload to OSSRH.
+
+:Required parameters:
+
+    :mvn-central: Whether or not to upload to mvn-central. (true|false)
+    :mvn-global-settings: The name of the Maven global settings to use for
+        Maven configuration. (default: global-settings)
+    :mvn-settings: The name of settings file containing credentials for the
+        project.
+    :ossrh-profile-id: Nexus staging profile ID as provided by OSSRH.
+
+.. literalinclude:: ../../.jjb-test/lf-macros/lf-maven-central-minimal.yaml
+   :language: yaml
+
+.. _lf-maven-install:
+

 lf-maven-install
 ----------------
 
 lf-maven-install
 ----------------
 


@@ -205,6 +242,24 @@ lf-rtd-verify
 
 ReadTheDocs verify script.
 
 
 ReadTheDocs verify script.
 

+check-info-votes
+----------------
+
+Calls shell script to validate votes on a change to an INFO.yaml
+
+lf-release
+----------
+
+releases lftools.ini (required)
+needed to push to nexus.
+
+[nexus]
+username=
+password=
+
+Then runs ../shell/release-job.sh
+
+

 lf-sigul-sign-dir
 -----------------
 
 lf-sigul-sign-dir
 -----------------
 


@@ -215,12 +270,43 @@ 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.
 :Required Parameters:
     :sign-artifacts: Whether or not to sign artifacts with Sigul.
     :sign-dir: Directory to sign.

+    :sign-mode: serial|parallel

 
 lf-infra-provide-docker-cleanup
 -------------------------------
 
 Forcibly removes all of the docker images.
 
 
 lf-infra-provide-docker-cleanup
 -------------------------------
 
 Forcibly removes all of the docker images.
 

+lf-infra-sonar
+---------------
+
+Runs Jenkins SonarQube plug-in.
+
+Requires ``SonarQube Scanner for Jenkins``
+
+:Optional Parameters:
+    :sonar-task: Sonar task to run. (default: "")
+    :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``
+
+: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-properties: Sonar configuration properties. (default: "")
+    :sonar-java-opts: JVM options. (default: "")
+    :sonar-additional-args: Additional command line arguments. (default: "")
+

 Parameters
 ==========
 
 Parameters
 ==========
 


@@ -271,6 +357,12 @@ lf-infra-tox-parameters
 Provides parameters needed by python-tox. Should be used by any jobs that need
 to run `tox <https://tox.readthedocs.io>`.
 
 Provides parameters needed by python-tox. Should be used by any jobs that need
 to run `tox <https://tox.readthedocs.io>`.
 

+
+lf-build-with-parameters-maven-release
+--------------------------------------
+
+Provides parameters needed for maven release jobs 'build with parameters'.
+

 Properties
 ==========
 
 Properties
 ==========
 


@@ -295,17 +387,11 @@ 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.
 
 used in all job templates. This primary objective of this trigger is to
 gather build logs and copy them to a log server.
 

-lf-stack-delete
----------------
-
-Requirements:
-
-* lftools >= v0.17.0
-
-Delete an openstack heat stack. Use at the end of a job that creates a stack.
+lf-infra-publish-windows
+------------------------

 
 

-This macro requires a parameter defined in the job named STACK_NAME
-containing the name of the stack to delete.
+Windows publisher for use at the end of Windows job templates. Takes care of
+cleaning out the workspace at the end of a job.

 
 SCM
 ===
 
 SCM
 ===


@@ -315,6 +401,13 @@ lf-infra-gerrit-scm
 
 Basic SCM configuration for Gerrit based projects.
 
 
 Basic SCM configuration for Gerrit based projects.
 

+:Required parameters:
+
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+    :submodule-disable: Disable submodule checkout operation.
+        (default: false)
+

 lf-infra-github-scm
 -------------------
 
 lf-infra-github-scm
 -------------------
 


@@ -324,6 +417,13 @@ On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
 as the value.  This will require that the job be triggered via
 the GHPRB plugin and not manually.
 
 as the value.  This will require that the job be triggered via
 the GHPRB plugin and not manually.
 

+:Required parameters:
+
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+    :submodule-disable: Disable submodule checkout operation.
+        (default: false)
+

 Wrappers
 ========
 
 Wrappers
 ========