Skip to content

Add cross-platform installer subproject and release CI - #3

Merged
AhmedAredah merged 3 commits into
mainfrom
feature/installer
May 7, 2026
Merged

Add cross-platform installer subproject and release CI#3
AhmedAredah merged 3 commits into
mainfrom
feature/installer

Conversation

@AhmedAredah

Copy link
Copy Markdown
Owner

Summary

  • Adds an installer/ subproject (opt-in via -DBUILD_INSTALLER=ON) that produces native packages and a Qt Installer Framework GUI installer (.run / .exe / .app) from a single CPack invocation.
  • Bundles Qt6 + ICU + RabbitMQ-C + Container into the install tree and patches RPATH on every shipped library so transitive Qt deps resolve. Verified end-to-end on Linux: terminal_simulation --help runs from the staged install with no LD_LIBRARY_PATH.
  • Defaults to ~/TerminalSim rather than /opt so non-admin installs work out of the box.
  • Adds a tagged-release CI workflow that mirrors the CargoNetSim pattern: builds on v* tags, fetches the private Container dependency via CONTAINER_REPO_TOKEN, produces the .run, attaches it to the GitHub Release, and appends a SHA256 checksum table to the release notes.
  • Fixes the README CargoNetSim link to point at AhmedAredah/CargoNetSim.

Layout

installer/
├── CMakeLists.txt            CPack + CPackIFW driver
├── cpack/                    Generator-specific config (DEB, RPM, NSIS, DragNDrop)
├── ifw/                      IFW control + per-component install scripts
├── deploy/                   windeployqt / macdeployqt / linuxdeploy + RPATH bundling
├── service/                  systemd unit, launchd plist, Windows Service helpers
└── assets/                   icon.{png,ico,icns}, IFW banner + watermark

Required action before tagging a release

Add the Container PAT as a repo secret:

gh secret set CONTAINER_REPO_TOKEN --repo AhmedAredah/TerminalSim

Without it the release workflow fails fast with a clear error.

Test plan

  • cmake -DBUILD_INSTALLER=ON configures cleanly with and without IFW available.
  • cpack -G "DEB;TGZ;IFW" produces all three artifacts on Ubuntu.
  • Installed .run produces a working binary that loads its bundled Qt + Container + RabbitMQ libs without LD_LIBRARY_PATH.
  • Default install location is ~/TerminalSim in the IFW wizard.
  • Tag a v* release and verify the workflow uploads the .run to the GitHub Release with checksum.

The README referenced VTTI-CSM/CargoNetSim, but the canonical mirror
lives under AhmedAredah/CargoNetSim now. Update the inline link to
match the active repo.
Adds installer/ subdirectory containing:

* CMake CPack configuration with platform-specific generator selection
  (DEB+RPM+TGZ on Linux, NSIS+ZIP on Windows, DragNDrop+TGZ on macOS,
  IFW everywhere) and component split (Runtime required, Service
  optional).
* Qt Installer Framework wiring through CPackIFW with branded wizard
  (icon, banner, watermark) and home-directory default install path.
* Runtime bundling helpers per platform: linuxdeploy/patchelf on Linux
  (with manual Qt6+ICU copy fallback and per-library RPATH patching so
  transitive Qt deps resolve), windeployqt on Windows, macdeployqt plus
  install_name_tool on macOS.
* Hardened systemd unit, launchd plist, and PowerShell service helpers
  shipped under share/terminalsim/service/ but never enabled by the
  installer; operator opts in explicitly.
* Branding assets generated from the project logo (icon.{png,ico,icns},
  IFW banner, IFW watermark).

Top-level CMakeLists.txt gains a BUILD_INSTALLER option that pulls in
the subproject and componentizes the install rules. The .gitignore
excludes the build_installer/ scratch directory and AGENTS.md.
Mirrors the CargoNetSim release pattern:

* Triggers on v* tags (and workflow_dispatch).
* Checks out the private AhmedAredah/container dependency at v0.2.0
  using a CONTAINER_REPO_TOKEN secret, fails fast if the secret is
  missing.
* Installs system Qt6 via apt and Qt Installer Framework via aqtinstall
  in an isolated Python venv.
* Builds Container, configures TerminalSim with BUILD_INSTALLER=ON, and
  produces a .run via cpack -G IFW.
* Renames the artifact to TerminalSim-<ref>-linux-x86_64.run, computes
  a SHA256 checksum, attaches the asset to the GitHub Release, and
  appends an idempotent ## Checksums section to the release notes.

Windows and macOS installer jobs are intentionally deferred until
signing and notarization are sorted.
@AhmedAredah
AhmedAredah merged commit 9d5d55c into main May 7, 2026
3 checks passed
@AhmedAredah
AhmedAredah deleted the feature/installer branch May 7, 2026 03:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant