ff0285ce6b
Backstory. The current approach for building documentation in the CI is that we build a static qdoc in a Jenkins job, manually provision it in qt5.git, and then build qt documentation using that somewhat old qdoc version. Updating the provisioned qdoc is a very slow process, because changes first need to be merged into qttools, then a Jenkins job needs to be manually run, then provisioning needs to be updated, and sometimes it also depends on a full qt5.git submodule update or has to wait for other unrelated changes to qt5.git. The new approach. This change adds CI instructions to build a static qdoc (and other relevant tools necessary for documentation generation) using the latest qttools/dev/HEAD sha1 in a specific host platform's qtbase build instructions, and then uses those tools for documentation generation and doc warning checks in each repo's TestDocs CI test phase. To enable these new instructions, the host platform and the doc checking platform need to be tagged with the 'DocsGenerationV2' feature. The built tools are cached in a separate archive using a new Coin feature, which is then extracted during each repo's TestDocs phase. Pros and cons. The benefit of this new approach is that we will always use a mostly up-to-date qdoc from qttools/dev/HEAD when generating documentation, making the documentation team's life easier. Specifically, once the doc tools are built in qtbase with the latest qttools/dev/HEAD sha1 that was available during that integration, the resulting built tools are then used for doc checks in dependent repos. A newer qttools/dev/HEAD sha1 will only be used for a particular repo once the qtbase dependencies.yaml sha1 is updated, or when doing qt5.git changes that cause a rebuild of qtbase. Note that while new tools are built due to dependency updates, the used qttools sha1 is not recorded in any way in any of the dependencies.yaml files. qtbase doc checks will always use the latest qttools/dev/HEAD sha1 at the integration time, because the tools will always be built from scratch. The downside of the new approach is that, by default, the doc generation will not use a pinned version of qdoc anymore, but rather follow the flow described above. This has a chance of introducing failures which are unrelated to integrating changes. This should happen rarely because the doc team usually tries to fix doc warnings before changing qdoc's code. If temporary pinning of qttools or qt5.git is required when testing the docs of a specific repo, it can be achieved as follows: - set the QT_CI_BUILD_REPO_DOC_TOOLS env var to "1" in the repo coin/module_config.yaml file build instructions, to ensure the doc tools are built in that repo, rather than reuse the ones built in qtbase - set the QT_CI_DOC_TOOLS_PIN_GIT_REF env var to the desired qttools sha1 or other git ref, in the same build instructions phase - optionally set the QT_CI_DOC_TOOLS_TOP_LEVEL_PIN_GIT_REF env var to the desired qt5.git sha1 or other git ref, in the same build instructions phase, if a different version of qt5.git is required - optionally set the QT_CI_DOC_TOOLS_USE_CI_TOP_LEVEL_BRANCH env var to ON, in case if the module branch that the CI job computes should be used as the qt5.git branch - set the QT_CI_FETCH_REPO_DOC_TOOLS env var to "1" in the repo test instructions, to ensure the just built doc tools are fetched instead of the qtbase-built ones Test running this new approach will allow us to collect some feedback on how often breakages happen, and how much easier it makes the documentation team's work, or how much harder it makes the life of regular integrations. The abundant amount of optional pinning options should be enough to avoid any permanent integration dead locks. Task-number: QTBUG-128730 Change-Id: I8606cb3076036a4a0ec652d0fa74d270e8f5dfdf Reviewed-by: Alexey Edelev <alexey.edelev@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 1f646bb978ed94c25f6224e801779c929096c0ae) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
48 lines
1.7 KiB
YAML
48 lines
1.7 KiB
YAML
type: Group
|
|
instructions:
|
|
- type: SetBuildDirectory
|
|
directory: "{{.SourceDir}}"
|
|
- type: ChangeDirectory
|
|
directory: "{{.BuildDir}}"
|
|
|
|
- !include "{{qt/qtbase}}/prepare_building_env.yaml"
|
|
|
|
# This tells the script where to install the doc tools, and what files the archive will contain.
|
|
- type: EnvironmentVariable
|
|
variableName: QT_CI_DOC_TOOLS_INSTALL_DIR
|
|
variableValue: "{{.BuildDir}}/doc_tools_build/install"
|
|
|
|
- type: ExecuteCommand
|
|
command: "{{.Env.ENV_PREFIX}} cmake -P {{.SourceDir}}/cmake/QtBuildStaticDocToolsScript.cmake"
|
|
executeCommandArgumentSplitingBehavior: SplitAfterVariableSubstitution
|
|
maxTimeInSeconds: 6000
|
|
maxTimeBetweenOutput: 1200
|
|
userMessageOnFailure: >
|
|
Failed to build doc tools.
|
|
enable_if:
|
|
condition: runtime
|
|
env_var: TESTED_MODULE_COIN
|
|
contains_value: qtbase
|
|
|
|
# For non-qtbase repos, call the build script from the installed folder.
|
|
- type: ExecuteCommand
|
|
command: "{{.Env.ENV_PREFIX}} cmake -P {{.Env.COIN_CMAKE_INSTALL_DIR}}/lib/cmake/Qt6/QtBuildStaticDocToolsScript.cmake"
|
|
executeCommandArgumentSplitingBehavior: SplitAfterVariableSubstitution
|
|
maxTimeInSeconds: 6000
|
|
maxTimeBetweenOutput: 1200
|
|
userMessageOnFailure: >
|
|
Failed to build doc tools.
|
|
disable_if:
|
|
condition: runtime
|
|
env_var: TESTED_MODULE_COIN
|
|
contains_value: qtbase
|
|
|
|
- type: UploadArtifact
|
|
archiveDirectory: "{{.Env.QT_CI_DOC_TOOLS_INSTALL_DIR}}"
|
|
transferType: GenericArtifactWithName
|
|
filename: "static_doc_tools_{{.Env.TESTED_MODULE_COIN}}.tar.gz"
|
|
maxTimeInSeconds: 1200
|
|
maxTimeBetweenOutput: 1200
|
|
userMessageOnFailure: >
|
|
Failed to upload built doc tools.
|