Merge "Readthedocs v2 jobs"
authorAric Gardner <agardner@linuxfoundation.org>
Tue, 15 Oct 2019 17:41:07 +0000 (17:41 +0000)
committerGerrit Code Review <gerrit@linuxfoundation.org>
Tue, 15 Oct 2019 17:41:07 +0000 (17:41 +0000)
1  2 
docs/jjb/lf-macros.rst
jjb/lf-macros.yaml

diff --combined docs/jjb/lf-macros.rst
@@@ -259,6 -259,17 +259,17 @@@ ReadTheDocs verify script. Installs an
      :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 <https://docs.readthedocs.io/en/stable/api/v3.html>`_
+ 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,14 -312,8 +312,14 @@@ Runs Jenkins SonarQube plug-in
  
  Requires ``SonarQube Scanner for Jenkins``
  
 +.. note:: Sonar properties can be set directly in the job definition by
 +   setting the sonar-project-file to ``""`` and adding all properties under
 +   ``sonar-properties``.
 +
  :Optional Parameters:
      :sonar-task: Sonar task to run. (default: "")
 +    :sonar-project-file: The filename for the project's properties
 +        (default: "sonar-project.properties")
      :sonar-properties: Sonar configuration properties. (default: "")
      :sonar-java-opts: JVM options. (default: "")
      :sonar-additional-args: Additional command line arguments. (default: "")
@@@ -321,17 -326,11 +332,17 @@@ the macro's caller
  
  Requires ``SonarQube Scanner for Jenkins``
  
 +.. note:: Sonar properties can be set directly in the job definition by
 +   setting the sonar-project-file to ``""`` and adding all properties under
 +   ``sonar-properties``.
 +
  :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-project-file: The filename for the project's properties
 +        (default: "sonar-project.properties")
      :sonar-properties: Sonar configuration properties. (default: "")
      :sonar-java-opts: JVM options. (default: "")
      :sonar-additional-args: Additional command line arguments. (default: "")
diff --combined jjb/lf-macros.yaml
        - shell: !include-raw-escape: ../shell/tox-install.sh
        - shell: !include-raw-escape: ../shell/rtd-verify.sh
  
+ - builder:
+     name: lf-rtdv2-build
+     builders:
+       - lf-infra-pre-build
+       - lf-infra-tox-install:
+           python-version: "python3"
+       - shell: !include-raw: ../shell/tox-run.sh
+       - shell: !include-raw: ../shell/rtdv2.sh
  - builder:
      name: check-info-votes
      builders:
            sonar-name: Sonar
            scanner-name: SonarQubeScanner
            task: "{sonar-task}"
 -          project: "sonar-project.properties"
 +          project: "{sonar-project-file}"
            properties: "{sonar-properties}"
            java-opts: "{sonar-java-opts}"
            additional-arguments: "{sonar-additional-args}"
            sonar-name: Sonar
            scanner-name: SonarQubeScanner
            task: "{sonar-task}"
 -          project: "sonar-project.properties"
 +          project: "{sonar-project-file}"
            properties: "{sonar-properties}"
            java-opts: "{sonar-java-opts}"
            additional-arguments: "{sonar-additional-args}"