Add cmake-sonar job

[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..4d2d4f5 100644 (file)
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -125,6 +125,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 +164,29 @@ 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)
+    :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
 ----------------
 


@@ -295,17 +320,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 +334,11 @@ 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)
+

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


@@ -324,6 +348,11 @@ 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)
+

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