[build] Include Qt license notices in Windows wheels

Author: Trinkle23897

.github/workflows/release.yml

@@ -242,6 +242,12 @@ jobs:
           Add-Content -Path $env:GITHUB_ENV -Value "BAZEL_RULES_QT_DIR=$env:QT_ROOT_DIR"
           Add-Content -Path $env:GITHUB_PATH -Value (Join-Path $env:QT_ROOT_DIR "bin")
           Add-Content -Path $env:GITHUB_PATH -Value "C:\Program Files\Git\usr\bin"
+      - name: Collect Qt licenses and notices
+        shell: bash
+        run: |
+          qt_prefix=$(cygpath -u "$QT_ROOT_DIR")
+          bash third_party/qt/build_release.sh --licenses-only "$qt_prefix"
+          echo "WHEEL_LICENSE_DIR=$(cygpath -m "$qt_prefix/licenses/qt6")" >> "$GITHUB_ENV"
       - name: Install bazelisk
         shell: pwsh
         run: |

docs/content/build.rst

@@ -177,6 +177,9 @@ Windows release wheels currently bundle the Qt runtime DLLs required by
 Procgen (``Qt6Core.dll`` and ``Qt6Gui.dll``) directly next to
 ``procgen_envpool.pyd``. End users installing the wheel do **not** need a
 separate Qt installation at runtime on Windows.
+The Qt license texts, SDK component notices, and build configuration are also
+included under ``.dist-info/licenses/qt6``. Release builds collect these with
+``third_party/qt/build_release.sh --licenses-only "$QT_ROOT_DIR"``.
 
 macOS wheels do not bundle Qt frameworks. Install Homebrew Qt 6 with
 ``brew install qtbase`` before importing EnvPool; the frameworks are required

third_party/qt/build_release.sh

@@ -15,11 +15,18 @@
 
 # Build the shared Qt raster runtime in the target manylinux image, not on the
 # host: upstream Qt binaries have a newer glibc baseline, especially on ARM64.
+# --licenses-only collects notices for the prebuilt Windows SDK instead.
 set -Eeuo pipefail
 
 qt_version=6.11.1
 qt_sha256=d9594a31228aa23ad6b531719a29b45f0f3989fe6c136d45767ea179f233c1ac
 qt_url="https://download.qt.io/official_releases/qt/6.11/$qt_version/submodules/qtbase-everywhere-src-$qt_version.tar.xz"
+licenses_only=false
+if [[ ${1:-} == --licenses-only ]]; then
+  licenses_only=true
+  shift
+  : "${1:?--licenses-only requires the installed Qt SDK path}"
+fi
 prefix=${1:-/opt/envpool-qt6}
 work_dir=$(mktemp -d)
 trap 'rm -rf "$work_dir"' EXIT
@@ -28,27 +35,37 @@ if [[ -z ${QT_SOURCE_ARCHIVE:-} ]]; then
   curl --fail --location --retry 3 --output "$archive" "$qt_url"
 fi
 printf '%s  %s\n' "$qt_sha256" "$archive" | sha256sum --check
-tar --no-same-owner -xf "$archive" -C "$work_dir"
 source_dir="$work_dir/qtbase-everywhere-src-$qt_version"
-mkdir "$work_dir/build"
-cd "$work_dir/build"
+if [[ $licenses_only == true ]]; then
+  sdk_version=$("$prefix/bin/qtpaths" --qt-version | tr -d '\r')
+  if [[ $sdk_version != "$qt_version" ]]; then
+    echo "Expected Qt $qt_version, found $sdk_version" >&2
+    exit 1
+  fi
+  tar --no-same-owner -xf "$archive" -C "$work_dir" \
+    "qtbase-everywhere-src-$qt_version/LICENSES"
+else
+  tar --no-same-owner -xf "$archive" -C "$work_dir"
+  mkdir "$work_dir/build"
+  cd "$work_dir/build"
 
-# Procgen uses QImage/QPainter and PNG assets, without windows or text. Keep
-# PNG in QtGui and build its small dependencies from Qt's pinned sources;
-# disabling ICU and display/font backends avoids a large system runtime stack.
-"$source_dir/configure" \
-  -prefix "$prefix" -libdir lib -release -shared \
-  -opensource -confirm-license -nomake examples -nomake tests \
-  -no-feature-network -no-feature-dbus -no-feature-sql \
-  -no-feature-widgets -no-feature-printsupport -no-feature-testlib \
-  -no-feature-xml -no-feature-concurrent \
-  -no-icu -no-glib -no-zstd -no-opengl -no-feature-vulkan \
-  -no-xcb -no-feature-wayland -no-feature-eglfs -no-feature-linuxfb \
-  -no-fontconfig -no-freetype -no-harfbuzz -no-libjpeg \
-  -qt-libpng -qt-zlib -qt-pcre \
-  -- -DQT_INSTALL_CONFIG_INFO_FILES=ON
-cmake --build . --parallel "${CMAKE_BUILD_PARALLEL_LEVEL:-2}"
-cmake --install . --strip
+  # Procgen uses QImage/QPainter and PNG assets, without windows or text. Keep
+  # PNG in QtGui and build its small dependencies from Qt's pinned sources;
+  # disabling ICU and display/font backends avoids a large system runtime stack.
+  "$source_dir/configure" \
+    -prefix "$prefix" -libdir lib -release -shared \
+    -opensource -confirm-license -nomake examples -nomake tests \
+    -no-feature-network -no-feature-dbus -no-feature-sql \
+    -no-feature-widgets -no-feature-printsupport -no-feature-testlib \
+    -no-feature-xml -no-feature-concurrent \
+    -no-icu -no-glib -no-zstd -no-opengl -no-feature-vulkan \
+    -no-xcb -no-feature-wayland -no-feature-eglfs -no-feature-linuxfb \
+    -no-fontconfig -no-freetype -no-harfbuzz -no-libjpeg \
+    -qt-libpng -qt-zlib -qt-pcre \
+    -- -DQT_INSTALL_CONFIG_INFO_FILES=ON
+  cmake --build . --parallel "${CMAKE_BUILD_PARALLEL_LEVEL:-2}"
+  cmake --install . --strip
+fi
 
 # Ship upstream license texts and attributions alongside the dynamically
 # linked libraries. The SBOM describes the Qt build before auditwheel repair.
@@ -61,12 +78,14 @@ This wheel includes Qt Core and Qt Gui $qt_version, dynamically linked under
 LGPL-3.0-only, and the third-party code identified in the Qt build SBOM.
 Copyright (C) The Qt Company Ltd. and other contributors.
 License texts are in LICENSES/; component copyright notices are in sbom/.
-The SBOM describes the upstream build before auditwheel renaming and stripping.
+The SBOM describes the upstream build before wheel repair and stripping.
 
 Unmodified corresponding Qt sources: $qt_url
 SHA256: $qt_sha256
-Build instructions and configuration: third_party/qt/build_release.sh in
-https://github.com/sail-sg/envpool
-The libraries in envpool.libs can be replaced with compatible modified Qt
-libraries; preserve their auditwheel-assigned filenames and dependency names.
+Linux build instructions: third_party/qt/build_release.sh in
+https://github.com/sail-sg/envpool. Windows uses the upstream Qt SDK.
+The build configuration is included here for both platforms.
+The libraries in envpool.libs (Linux) or envpool/procgen (Windows) can be
+replaced with compatible modified Qt libraries; preserve their filenames
+and dependency names, including auditwheel-assigned names on Linux.
 EOF