Fix: Enable git submodules in GitHub Actions to resolve Flatpak build failure

[Copilot]

Problem

The Flatpak build was failing with the following error:

** (flatpak-builder:4751): ERROR **: 15:22:14.103: Failed to load included manifest (/home/runner/work/com.citrix.ICAClient/com.citrix.ICAClient/shared-modules/libsoup/libsoup-2.4.json): Failed to open file "/home/runner/work/com.citrix.ICAClient/com.citrix.ICAClient/shared-modules/libsoup/libsoup-2.4.json": No such file or directory

The build manifest com.citrix.ICAClient.yml references shared-modules/libsoup/libsoup-2.4.json on line 46, but this file was not available during the CI build.

Root Cause

The repository has shared-modules correctly configured as a git submodule pointing to the Flathub shared-modules repository, but the GitHub Actions workflow was using actions/checkout@v4 without the submodules: true option. This meant that while the submodule directory existed, it was empty and didn't contain the required libsoup-2.4.json file.

Solution

Updated the GitHub Actions workflow (.github/workflows/flatpak-build.yml) to properly initialize git submodules during checkout:

- name: Checkout repository
  uses: actions/checkout@v4
  with:
    submodules: true

This ensures that the shared-modules submodule is populated with all required files from the Flathub shared-modules repository, including the libsoup-2.4.json manifest that webkit2gtk-4.0 depends on.

Testing

Verified that:

• The submodule points to the correct Flathub repository commit (73f08ed)
• The required file shared-modules/libsoup/libsoup-2.4.json exists and contains valid JSON
• The manifest reference resolves correctly to the actual file

This minimal change should resolve the Flatpak build failure without requiring any modifications to the existing submodule configuration or build dependencies.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.