From ff33e05030b95c28f28f1317f6ac713080e8a5fa Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Fri, 20 Dec 2019 15:21:48 -0500 Subject: [PATCH] Allow projects to set their tox-dir default is "." Projects that don't want tox dir to be "." can set it to "docs/" also call to shell must be a include-raw-escape ISSUE-ID: RELENG-2520 Signed-off-by: Aric Gardner Change-Id: I53296072928b1a112213c7d041059c4e0b185812 --- docs/jjb/lf-rtdv3-jobs.rst | 12 +++++++++++- jjb/lf-macros.yaml | 2 +- jjb/lf-rtdv3-jobs.yaml | 2 ++ releasenotes/notes/lf-rtdv3-jobs-2e68fdc189f322df.yaml | 6 ++++++ 4 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 releasenotes/notes/lf-rtdv3-jobs-2e68fdc189f322df.yaml diff --git a/docs/jjb/lf-rtdv3-jobs.rst b/docs/jjb/lf-rtdv3-jobs.rst index 8fe73f9b..85a1480e 100644 --- a/docs/jjb/lf-rtdv3-jobs.rst +++ b/docs/jjb/lf-rtdv3-jobs.rst @@ -56,6 +56,14 @@ 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. +The default location of the tox.ini file is in the git repository root +directory. Optionally your documentation lead may decide to store all tox files +within the required "docs" subdirectory by setting configuration option +"tox-dir" to value "docs/" as discussed below. + +If your project's tox dir is "docs/" and not "." the tox.ini must be +reconfigured with the correct relative paths. + Once these files are correctly configured in your repository you can test locally: @@ -137,6 +145,7 @@ example file: ci-management/jjb/rtd/rtd.yaml name: rtdv3-global-verify build-node: centos7-builder-1c-1g default-version: latest + tox-dir: "." jobs: - rtdv3-global-verify stream: @@ -166,6 +175,7 @@ Or add both jobs via a job group: - project: name: rtdv3-global default-version: latest + tox-dir: "." build-node: centos7-builder-1c-1g jobs: - rtdv3-global @@ -279,7 +289,7 @@ Also outputs some info on the build. (default: 10) :submodule-disable: Disable submodule checkout operation. (default: false) - + :tox-dir: Directory containing the project's read the docs tox.ini :gerrit_verify_triggers: Override Gerrit Triggers. :gerrit_trigger_file_paths: Override file paths filter which checks which file modifications will trigger a build. diff --git a/jjb/lf-macros.yaml b/jjb/lf-macros.yaml index 1c4e5f40..6d192bf4 100644 --- a/jjb/lf-macros.yaml +++ b/jjb/lf-macros.yaml @@ -282,7 +282,7 @@ - inject: properties-content: | DEFAULT_VERSION={default-version} - - shell: !include-raw: ../shell/rtdv3.sh + - shell: !include-raw-escape: ../shell/rtdv3.sh - builder: name: check-info-votes diff --git a/jjb/lf-rtdv3-jobs.yaml b/jjb/lf-rtdv3-jobs.yaml index ba037137..d916d1af 100644 --- a/jjb/lf-rtdv3-jobs.yaml +++ b/jjb/lf-rtdv3-jobs.yaml @@ -17,6 +17,7 @@ submodule-recursive: true submodule-disable: false submodule-timeout: 10 + tox-dir: "." gerrit-skip-vote: false gerrit_trigger_file_paths: @@ -65,6 +66,7 @@ - inject: properties-content: | TOX_ENVS=docs,docs-linkcheck + TOX_DIR={tox-dir} - lf-infra-tox-run: parallel: "true" - lf-rtdv3-build: diff --git a/releasenotes/notes/lf-rtdv3-jobs-2e68fdc189f322df.yaml b/releasenotes/notes/lf-rtdv3-jobs-2e68fdc189f322df.yaml new file mode 100644 index 00000000..eb8274d5 --- /dev/null +++ b/releasenotes/notes/lf-rtdv3-jobs-2e68fdc189f322df.yaml @@ -0,0 +1,6 @@ +--- +features: + - | + Make tox-dir configurable + default is "." + can now be set to "docs/" -- 2.16.6