diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-06-17 09:35:11 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2020-11-30 10:13:11 +0100 |
| commit | 6ca25c535a2f1c7a2f80bac0c9b1f3993fd18963 (patch) | |
| tree | b8bd3093bbcd353156386db95e9c85235ea645e5 /coin | |
| parent | 021a1758527095a974be4b1c09cacd8f39e90e3c (diff) | |
CI: Run QDoc as part of testing cycle
Run QDoc in generate phase on documentation in qttools, with specific
environment variables set. These instruct QDoc to ignore documentation
linking errors to other modules, and terminate with a non-zero exit
code if other warnings exceed the limit set in each documentation
project. Select a platform with 'TestDocs' feature for testing.
This enables CI to block changes that introduce new documentation
warnings.
Task-number: QTBUG-78069
Change-Id: Ie743a68ed5dc49cfb06ea03cffa0eb64dbb1664e
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Diffstat (limited to 'coin')
| -rw-r--r-- | coin/module_config.yaml | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/coin/module_config.yaml b/coin/module_config.yaml index 16d158c6b..5069e9d7a 100644 --- a/coin/module_config.yaml +++ b/coin/module_config.yaml @@ -10,3 +10,29 @@ instructions: Test: - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml" + - type: Group + instructions: + - !include "{{qt/qtbase}}/prepare_building_env.yaml" + - type: EnvironmentVariable + variableName: QDOC_NOLINKERRORS + variableValue: 1 + - type: EnvironmentVariable + variableName: QDOC_ENABLE_WARNINGLIMIT + variableValue: 1 + - type: SetBuildDirectory + directory: "{{.SourceDir}}" + - type: ChangeDirectory + directory: "{{.BuildDir}}" + - type: EnvironmentVariable + variableName: COIN_CMAKE_ARGS + variableValue: "-DBUILD_TESTING=OFF {{.SourceDir}}" + - !include "{{qt/qtbase}}/call_cmake.yaml" + - type: ExecuteCommand + command: "cmake --build . --target generate_docs" + maxTimeInSeconds: 1800 + maxTimeBetweenOutput: 900 + userMessageOnFailure: "Documentation check failed, see the log for details." + enable_if: + condition: property + property: features + contains_value: "TestDocs" |