:doc-dir: Document directory.
:python-version: Python version.
-lf-rtdv2-build
+lf-rtdv3-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
+Read the docs scripts that leverage 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.
+Runs tox to verify that the docs are good and then runs the RTDv3 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.
+Jobs will run but skip verify bits until a .readthedocs.yaml is found in the root
+of their repository.
check-info-votes
-.. _lf-global-jjb-rtdv2-jobs:
+.. _lf-global-jjb-rtdv3-jobs:
##########################
-ReadTheDocs Version:2 Jobs
+ReadTheDocs Version:3 Jobs
##########################
-This is a global job that only needs to be added once to your project's ci-mangement git repository. It leverages the read the docs v3 api to create projects on the fly, as well as set up subproject associations with the master doc.
+User setup:
+
+To transform your rst documentation into a read the docs page, this job must be configured and
+created as described in Admin setup below. Once this is complete the following files must be
+added to your repository:
+
+.. code-block:: bash
+
+ .readthedocs.yaml
+ tox.ini
+ docs
+ docs/_static
+ docs/_static/logo.png
+ docs/conf.yaml
+ docs/favicon.ico
+ docs/index.rst
+ docs/requirements-docs.txt
+ docs/conf.py
+
+Rather than have you copy and paste these files from a set of docs here, the following repo
+contains a script that will do this for you. Please refer to the explanation presented in:
+https://github.com/lfit-sandbox/test
+This is all currently a beta feature, so feedback is encouraged.
+the script `docs_script.sh` is not needed, you can copy the files by hand if you prefer
+
+Once these files are correctly configured in your repository you can test locally:
+
+.. code-block:: bash
+
+ tox -e docs,docs-linkcheck
+
+
+Admin setup:
+
+This is a global job that only needs to be added once to your project's ci-mangement git
+repository. It leverages the read the docs v3 api to create projects on the fly, as well
+as setting up subproject associations with the master doc.
+
+Jobs will run but skip any actual verification until a .readthedocs.yaml is placed in the
+root of the repository
The master doc must be defined in
jenkins-config/global-vars-{production|sandbox}.sh
+Normally this project is called doc or docs or documentation and all other docs build will
+be set as a subproject of this job.
+
examples:
global-vars-sandbox.sh:
MASTER_RTD_PROJECT=doc-test
global-vars-production.sh:
MASTER_RTD_PROJECT=doc
-In this way sandbox jobs will create docs with a test suffix and will not stomp on production documentation.
+In this way sandbox jobs will create docs with a test suffix and will not stomp on production
+documentation.
Example job config:
---
- project:
- name: rtdv2-verify-global
+ name: rtdv3-global-verify
build-node: centos7-builder-1c-1g
jobs:
- - rtdv2-verify-global
+ - rtdv3-global-verify
stream:
- master:
branch: master
branch: stable/{stream}
- project:
- name: rtdv2-merge-global
+ name: rtdv3-global-merge
build-node: centos7-builder-1c-1g
jobs:
- - rtdv2-merge-global
+ - rtdv3-global-merge
stream:
- master:
branch: master
---
- project:
- name: rtdv2-global
+ name: rtdv3-global
build-node: centos7-builder-1c-1g
jobs:
- - rtdv2-global
+ - rtdv3-global
stream:
- master:
branch: master
Macros
======
-lf-rtdv2-common
+lf-rtdv3-common
---------------
RTD verify and merge jobs are the same except for their scm, trigger, and
Job Templates
=============
-ReadTheDocs v2 Merge
+ReadTheDocs v3 Merge
--------------------
Merge job which triggers a build of the docs to readthedocs.
:Template Names:
- - rtdv2-merge-global-{stream}
+ - rtdv3-global-merge-{stream}
:Comment Trigger: remerge
**default**::
- compare-type: REG_EXP
- pattern: '.*\.css'
- - compare-type: REG_EXP
- pattern: '.*\.html'
- - compare-type: REG_EXP
- pattern: '.*\.rst'
- - compare-type: REG_EXP
- pattern: '.*\/conf.py'
+ pattern: '^docs\/.*'
-
-ReadTheDocs v2 Verify
+ReadTheDocs v3 Verify
---------------------
Verify job which runs a tox build of the docs project.
-Also outputs some info on the build
+Also outputs some info on the build.
:Template Names:
- - rtdv2-verify-global-{stream}
+ - rtdv3-global-verify-{stream}
:Comment Trigger: recheck|reverify
**default**::
- compare-type: REG_EXP
- pattern: '.*\.css'
- - compare-type: REG_EXP
- pattern: '.*\.html'
- - compare-type: REG_EXP
- pattern: '.*\.rst'
- - compare-type: REG_EXP
- pattern: '.*\/conf.py'
+ pattern: '^docs\/.*'
- shell: !include-raw-escape: ../shell/rtd-verify.sh
- builder:
- name: lf-rtdv2-build
+ name: lf-rtdv3-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
+ - conditional-step:
+ condition-kind: file-exists
+ condition-filename: .readthedocs.yaml
+ on-evaluation-failure: dont-run
+ steps:
+ - inject:
+ properties-content: |
+ TOX_ENVS=docs,docs-linkcheck
+ - lf-infra-pre-build
+ - lf-infra-tox-install:
+ python-version: "python3"
+ - shell: !include-raw: ../shell/tox-run.sh
+ - shell: !include-raw: ../shell/rtdv3.sh
- builder:
name: check-info-votes
+++ /dev/null
----
-- job-group:
- name: "rtdv2-global"
-
- jobs:
- - rtdv2-verify-global
- - rtdv2-merge-global
--- /dev/null
+---
+- job-group:
+ name: "rtdv3-global"
+
+ jobs:
+ - rtdv3-global-verify
+ - rtdv3-global-merge
---
-- lf_rtdv2_common: &lf_rtdv2_common
- name: lf-rtdv2-common
+- lf_rtdv3_common: &lf_rtdv3_common
+ name: lf-rtdv3-common
######################
# Default parameters #
gerrit_trigger_file_paths:
- compare-type: REG_EXP
- pattern: '.*\.css'
- - compare-type: REG_EXP
- pattern: '.*\.html'
- - compare-type: REG_EXP
- pattern: '.*\.rst'
- - compare-type: REG_EXP
- pattern: '.*\/conf.py'
+ pattern: '^docs\/.*'
#####################
# Job Configuration #
files:
- file-id: lftoolsini
target: "$HOME/.config/lftools/lftools.ini"
- - lf-rtdv2-build
+ - lf-rtdv3-build
- job-template:
- name: "rtdv2-verify-global-{stream}"
- id: rtdv2-verify-global
- <<: *lf_rtdv2_common
+ name: "rtdv3-global-verify-{stream}"
+ id: rtdv3-global-verify
+ <<: *lf_rtdv3_common
# yamllint disable-line rule:key-duplicates
stream: master
- branch-compare-type: "ANT"
branch-pattern: "**/{branch}"
file-paths: "{obj:gerrit_trigger_file_paths}"
+ forbidden-file-paths:
+ - compare-type: REG_EXP
+ pattern: ".*global-jjb.*"
+
skip-vote:
successful: "{gerrit-skip-vote}"
failed: "{gerrit-skip-vote}"
notbuilt: "{gerrit-skip-vote}"
- job-template:
- name: "rtdv2-merge-global-{stream}"
- id: rtdv2-merge-global
- <<: *lf_rtdv2_common
+ name: "rtdv3-global-merge-{stream}"
+ id: rtdv3-global-merge
+ <<: *lf_rtdv3_common
######################
# Default parameters #
--- /dev/null
+---
+features: >
+ Read-the-docs job will run but skip its verification bits unless the repo has
+ .readthedocs.yaml file in the root of its repository. This allows projects to
+ commit changes to their docs/ dir without having to configure the read the
+ docs builds.
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
##############################################################################
-echo "---> rtd-verify.sh"
+echo "---> rtdv3.sh"
set -euo pipefail
project_dashed="${PROJECT////-}"
echo "INFO: Project not found, merge will create project https://$rtdproject.readthedocs.io"
fi
-echo "INFO: Merge will run"
-echo "INFO: lftools rtd project-build-trigger $rtdproject $STREAM"
+echo "INFO: Verify job completed"
fi
if [[ "$JOB_NAME" =~ "merge" ]]; then
+echo "INFO: Running merge job"
# This retuns null if project exists.
project_exists=false
Code Review / releng / global-jjb.git / commitdiff