X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=6404cc9f3f9ffc5a3cc22990868aa8a011fed14a;hb=d60a07de920a48e44fa34242c774e3a9f04250dc;hp=e628179dac02916f66806b69e020bd61c5861925;hpb=4028ad2bc487460837736f040d885c3674b39031;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index e628179d..6404cc9f 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -259,6 +259,17 @@ ReadTheDocs verify script. Installs and runs tox. :doc-dir: Document directory. :python-version: Python version. +lf-rtdv2-build +--------------- + +ReadTheDocs Version 2 verify and merge scripts. +This is an update to the read the docs scripts that leverages the new Read the Docs v3 api +`RTD v3 API `_ +Runs tox to verify that the docs are good and then runs the RTDv2 shell script. +This script handles creating projects as needed, assiging subprojects to the main +read the docs project and triggering builds to update the documentation. + + check-info-votes ---------------- @@ -301,6 +312,23 @@ 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: "")