qt6-bb10/coin/instructions
Lucie Gérard 37804d9555 Add calling license check on generated source SBOM
The license check is only called if VERIFY_SOURCE_SBOM is set to ON
in the module_config.yaml. This way, a module can turn on the check
only when ready.

The license check is done via a perl script. Since no perl is
available for Windows on ARM64, VERIFY_SOURCE_SBOM is set to OFF
in this case.

Task-number: QTBUG-131434
Change-Id: I183b7726928bbc925940330d39779a4ac2307254
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
(cherry picked from commit 153002f7d2904988efdd8abc68adff0f9927943b)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
(cherry picked from commit 01e5801cec6d444193c97a57faf3008b93f1d1d7)
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
2025-02-03 18:07:34 +01:00
..
debian COIN: Move skipping Debian instructions to qt5 repo 2024-02-22 15:54:25 +00:00
qmake Change the license of all CMakeLists.txt and *.cmake files to BSD 2022-08-23 23:58:42 +02:00
qmake_examples Revert "Revert "coin: Build qmake examples in non-qtbase repos"" 2023-01-16 18:18:28 +00:00
README.md coin: Use configure and qt-configure-module in instructions 2022-03-17 17:14:36 +01:00
call_cmake_for_standalone_examples.yaml coin: Add instructions to build standalone examples 2024-03-14 11:44:16 +01:00
call_cmake_for_standalone_tests.yaml Move bin/qt-internal-configure-tests to libexec 2021-03-30 14:39:12 +01:00
call_configure_module.yaml coin: Use configure and qt-configure-module in instructions 2022-03-17 17:14:36 +01:00
call_configure_qtbase.yaml coin: Use configure and qt-configure-module in instructions 2022-03-17 17:14:36 +01:00
call_host_install.yaml coin: Fix installation failing during tqtc-qt5.git integrations 2023-11-22 21:15:38 +01:00
call_target_install.yaml coin: Fix installation failing during tqtc-qt5.git integrations 2023-11-22 21:15:38 +01:00
cmake_build_and_upload_test_artifacts.yaml Coin: Add a way to disable test upload 2024-06-19 13:14:45 +00:00
cmake_build_and_upload_test_artifacts_host.yaml Add feature to disable building tests 2023-06-12 13:46:07 +00:00
cmake_build_and_upload_test_artifacts_target.yaml Add feature to disable building tests 2023-06-12 13:46:07 +00:00
cmake_build_standalone_examples.yaml coin: Add instructions to build standalone examples 2024-03-14 11:44:16 +01:00
cmake_build_standalone_examples_host.yaml coin: Add instructions to build standalone examples 2024-03-14 11:44:16 +01:00
cmake_build_standalone_examples_target.yaml coin: Add instructions to build standalone examples 2024-03-14 11:44:16 +01:00
cmake_cross_compilation_module_build_instructions.yaml coin: Move cross-compilation build directories outside of sources 2024-10-08 16:46:36 +00:00
cmake_cross_compilation_qtbase_build_instructions.yaml coin: Move cross-compilation build directories outside of sources 2024-10-08 16:46:36 +00:00
cmake_documentation_build.yaml Adjust documentation build dir for out of source builds 2022-06-27 11:05:23 +00:00
cmake_module_build_instructions.yaml Revert "Coin: sign only x86 packages" 2024-11-02 13:49:14 +00:00
cmake_qtbase_build_instructions.yaml Revert "Coin: sign only x86 packages" 2024-11-02 13:49:14 +00:00
cmake_regular_test_instructions.yaml coin: Make macOS 12 and 13 Tart ARM VMs significant 2024-06-03 12:57:01 +00:00
cmake_run_ctest.yaml coin: Decide whether to ignore CTest exit code based on environment var 2024-05-29 20:12:44 +02:00
cmake_setup_running_qnxqemu_tests_env_vars.yaml Clean up QNX platform configs and improve testrunner scripts 2022-02-14 12:56:06 +01:00
cmake_setup_running_tests_env_vars.yaml Introduce qt-testrunner.py 2022-01-03 16:32:56 +01:00
coin_build_doc_tools.yaml coin: Build qdoc as part of repo instructions for CI doc building 2024-11-02 14:49:15 +01:00
coin_build_doc_tools_checked.yaml coin: Build qdoc as part of repo instructions for CI doc building 2024-11-02 14:49:15 +01:00
coin_fetch_doc_tools.yaml coin: Build qdoc as part of repo instructions for CI doc building 2024-11-02 14:49:15 +01:00
coin_module_axivion_template_v2.yaml Fix mount command 2024-02-15 09:52:52 +02:00
coin_module_build_template_v2.yaml Add calling license check on generated source SBOM 2025-02-03 18:07:34 +01:00
coin_module_test_android_start_emulator.yaml Android: unset QT_IM_MODULE when running Android tests 2024-10-17 19:30:34 +00:00
coin_module_test_docs.yaml coin: De-duplicate test docs instructions 2024-11-02 14:49:15 +01:00
coin_module_test_qemu_env_vars.yaml CMake: Add instructions for building and testing qemu configs 2020-06-25 14:11:56 +02:00
coin_module_test_qnx_start_emulator.yaml Coin: Prefer publickey in QNX emulator ssh 2024-08-05 19:28:43 +00:00
coin_module_test_template_common.yaml COIN/Android: Move android_emulator_launcher.sh to qt5.git 2023-07-25 23:07:45 +03:00
coin_module_test_template_v2.yaml coin: Add instructions for running license checker during test phase 2024-07-30 12:50:37 +00:00
coin_module_test_template_v3.yaml coin: Add instructions for running license checker during test phase 2024-07-30 12:50:37 +00:00
coin_qtbase_build_template_v2.yaml Add calling license check on generated source SBOM 2025-02-03 18:07:34 +01:00
coin_qtbase_test_docs.yaml coin: De-duplicate test docs instructions 2024-11-02 14:49:15 +01:00
coin_test_docs_common.yaml coin: Build qdoc as part of repo instructions for CI doc building 2024-11-02 14:49:15 +01:00
prepare_android_multi_abi_env.yaml Add support of Android multi-ABI builds 2022-11-04 18:39:03 +01:00
prepare_building_env.yaml coin: Always pass the SBOM python interpreter to configure 2024-10-21 08:37:24 +00:00
prepare_configure_executable.yaml coin: Use configure and qt-configure-module in instructions 2022-03-17 17:14:36 +01:00
prepare_configure_module_executable.yaml Return qt-configure-module to bin/ 2022-12-13 10:02:25 +00:00
prepare_install_dir_suffix_host.yaml coin: Use configure and qt-configure-module in instructions 2022-03-17 17:14:36 +01:00
prepare_install_dir_suffix_target.yaml coin: Use configure and qt-configure-module in instructions 2022-03-17 17:14:36 +01:00
prepare_license_test.yaml Add calling license check on generated source SBOM 2025-02-03 18:07:34 +01:00
prepare_source_sbom_check.yaml Add calling license check on generated source SBOM 2025-02-03 18:07:34 +01:00
run_license_check.yaml Add calling license check on generated source SBOM 2025-02-03 18:07:34 +01:00

README.md

Information about Coin instruction templates

Build templates

  • coin_qtbase_build_template_v2.yaml did not exist. The build instructions were directly embedded into module_config.yaml and did not support repos outside of qtbase, also no cross-compilation.
  • coin_qtbase_build_template_v2 introduced support for building other repos, and also enabled build cross-compiling targets like Android and iOS. A bit later the template gained the ability to build qemu cross-compiling configurations. The counterpart to qtbase to build other repositories is coin_module_build_template_v2

Test templates

  • coin_module_test_template_v1 did not exist. The test instructions were directly embedded into module_config.yaml and did not support repos outside of qtbase, also no cross-compilation.
  • coin_module_test_template_v2 introduced support for building tests for other repos, and made sure not to build and run tests on cross-compiling configuration. A bit later the template gained the ability to build and run tests for qemu cross-compiling configurations.
  • coin_module_test_template_v3 changed the run test instructions to not ignore the exit code and thus enforce that tests pass in the CI.

Environment variable description and usage

The following environment variables are used in Coin instructions when building Qt, tests, etc:

CONFIGURE_ARGS - contains platform-specific configure-style arguments (e.g. -shared), that will be passed to a qtbase configure call CMAKE_ARGS - contains platform-specific CMake-style arguments (e.g. -DOPENSSL_ROOT_DIR=Foo) that will be passed to a qtbase configure call NON_QTBASE_CONFIGURE_ARGS - contains platform-specific configure-style arguments that will be passed to a non-qtbase qt-configure-module call NON_QTBASE_CMAKE_ARGS - contains platform-specific CMake-style arguments that will be passed to a non-qtbase qt-configure-module call COMMON_CMAKE_ARGS - platform-independent CMake-style args set in prepare_building_env.yaml that apply to qtbase configurations only. COMMON_NON_QTBASE_CMAKE_ARGS - platform-independent CMake-style args set in prepare_building_env.yaml that apply to configuration of repos other than qtbase COMMON_TEST_CMAKE_ARGS - platform-independent CMake-style args set in prepare_building_env.yaml that apply to configuration of all standalone tests

All of the above apply to host builds only.

There is a a set of environment variables that apply to target builds when cross-compiling which mirror the ones above. They are:

TARGET_CONFIGURE_ARGS TARGET_CMAKE_ARGS NON_QTBASE_TARGET_CONFIGURE_ARGS NON_QTBASE_TARGET_CMAKE_ARGS

COMMON_TARGET_CMAKE_ARGS COMMON_NON_QTBASE_TARGET_CMAKE_ARGS COMMON_TARGET_TEST_CMAKE_ARGS

Currently, there are no common configure-style variables for configuring repos or tests, only ``CMake-style` ones.

COIN_CMAKE_ARGS contains the final set of cmake args that is passed to configure / qt-configure-module, it is built up from the variables above + any additional values added by custom instructions, like specification of CMAKE_INSTALL_PREFIX etc.

INSTALL_DIR_SUFFIX is used to append either /host or /target suffixes to install paths in instructions when cross-building.

CONFIGURE_EXECUTABLE contains a platform-specific path to configure / qt-configure-module or cmake/ qt-cmake depending on whether UseConfigure feature is enabled.

CONFIGURE_ENV_PREFIX contains the value of either ENV_PREFIX or TARGET_ENV_PREFIX depending on whether it's a cross-build configure call. The values are used when configuring and building, to ensure that things like compilers are found correctly.

We use unixPathSeparators to pass an install prefix with forward slashes even on Windows, to avoid escaping issues when using configure.