Merge pull request #118 from pablogventura/feature/flatpak-manifest-ci-docs

Flatpak: runtime refresh, tag CI bundle, README, Boost without tests

Author: vigri

.github/workflows/flatpak.yml

@@ -0,0 +1,49 @@
+# Build the in-repo Flatpak manifest on release tags (smoke test + downloadable bundle).
+# This does not publish to Flathub; see README and https://github.com/ScanTailor-Advanced/scantailor-advanced/issues/105
+name: Flatpak
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  flatpak:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 120
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Flatpak tools
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y flatpak flatpak-builder
+
+      - name: Add Flathub remote
+        run: |
+          flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
+
+      - name: Cache flatpak-builder
+        uses: actions/cache@v4
+        with:
+          path: .flatpak-builder
+          key: flatpak-builder-${{ hashFiles('flatpak/org.scantailor.Advanced.json') }}-${{ runner.os }}
+
+      - name: Build Flatpak
+        run: |
+          flatpak-builder --user --repo=repo --force-clean build-dir flatpak/org.scantailor.Advanced.json --install-deps-from=flathub
+
+      - name: Create single-file bundle
+        run: |
+          flatpak build-bundle repo "ScanTailor-Advanced-${{ github.ref_name }}.flatpak" org.scantailor.Advanced
+
+      - name: Upload bundle
+        uses: actions/upload-artifact@v4
+        with:
+          name: ScanTailor-Advanced-flatpak-${{ github.ref_name }}
+          path: "*.flatpak"
+          if-no-files-found: error

CMakeLists.txt

@@ -70,6 +70,9 @@ endif()
 
 st_set_default_build_type(Release)
 
+# Must be set before Boost (Flatpak and other chroot builds use -DBUILD_TESTS=OFF; issue #61).
+option(BUILD_TESTS "Build unit tests (math_tests, imageproc_tests, core_tests, foundation_tests, qt_tests)" ON)
+
 if (NOT CMAKE_RUNTIME_OUTPUT_DIRECTORY)
   set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}")
 endif()
@@ -193,15 +196,21 @@ if (WIN32)
 endif()
 set(Boost_USE_MULTITHREADED ON)
 
-find_package(Boost 1.60 COMPONENTS unit_test_framework REQUIRED)
+if (BUILD_TESTS)
+  find_package(Boost 1.60 COMPONENTS unit_test_framework REQUIRED)
+else()
+  find_package(Boost 1.60 REQUIRED)
+endif()
 
 include_directories(${Boost_INCLUDE_DIRS})
 add_definitions(-DBOOST_MULTI_INDEX_DISABLE_SERIALIZATION)
-if (NOT Boost_USE_STATIC_LIBS)
-  if (WIN32)
-    add_dynamic_library_locations(Boost::unit_test_framework)
+if (BUILD_TESTS)
+  if (NOT Boost_USE_STATIC_LIBS)
+    if (WIN32)
+      add_dynamic_library_locations(Boost::unit_test_framework)
+    endif()
+    add_definitions(-DBOOST_TEST_DYN_LINK)
   endif()
-  add_definitions(-DBOOST_TEST_DYN_LINK)
 endif()
 
 #=================================== Qt ===================================#
@@ -266,8 +275,6 @@ if (WIN32 AND MSVC)
   add_definitions(-DNOMINMAX)
 endif()
 
-# Option to disable tests for offline/chroot builds where Boost or test deps may be missing (issue #61).
-option(BUILD_TESTS "Build unit tests (math_tests, imageproc_tests, core_tests, foundation_tests, qt_tests)" ON)
 if (BUILD_TESTS)
   enable_testing()
 endif()

README.md

@@ -76,7 +76,16 @@ Go to [this repository](https://github.com/ScanTailor-Advanced/scantailor-libs-b
 
 **Linux – Wayland (issue #97):** If you see rendering issues (blank or corrupted windows) when running under Wayland, try starting the application with `QT_QPA_PLATFORM=xcb` to use the X11 compatibility layer.
 
-**Linux – Flatpak / Flathub (issue #105):** End users should prefer **pre-built** binaries from [GitHub Releases](https://github.com/ScanTailor-Advanced/scantailor-advanced/releases) when available (`.deb` / AppImage on tagged releases). A Flatpak manifest for **maintainers** is in `flatpak/org.scantailor.Advanced.json` (`flatpak-builder --user --force-clean build flatpak/org.scantailor.Advanced.json`). Publishing on Flathub needs a **new** application ID (e.g. `org.scantailor.Advanced`) so it does not replace the legacy `com.github._4lex4.*` app.
+**Linux – Flatpak / Flathub ([issue #105](https://github.com/ScanTailor-Advanced/scantailor-advanced/issues/105)):**
+
+| | |
+|--|--|
+| **Day-to-day binaries** | Prefer [GitHub Releases](https://github.com/ScanTailor-Advanced/scantailor-advanced/releases) when the project publishes `.deb` / AppImage (or other) builds for a tagged version. |
+| **Install from Flathub** | There is **no** official Flathub listing yet for this fork under the new ID. Shipping there requires a maintainer to follow [Flathub submission](https://docs.flathub.org/docs/for-app-authors/submission/) (separate repo/PR to [flathub/flathub](https://github.com/flathub/flathub)), AppStream metainfo, screenshots, and reviewer feedback. The in-repo manifest is meant to make that step mostly mechanical; issue [#105](https://github.com/ScanTailor-Advanced/scantailor-advanced/issues/105) tracks coordination. |
+| **Local Flatpak (maintainers / QA)** | Manifest: [`flatpak/org.scantailor.Advanced.json`](flatpak/org.scantailor.Advanced.json). Example: `flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo` then `flatpak-builder --user --install-deps-from=flathub --force-clean build-dir flatpak/org.scantailor.Advanced.json` (installs the KDE runtime/SDK from Flathub on first run). |
+| **CI smoke build** | On each **`v*` tag** push (and via **workflow dispatch**), [`.github/workflows/flatpak.yml`](.github/workflows/flatpak.yml) runs `flatpak-builder` and uploads a **`.flatpak` bundle** as a workflow artifact for smoke testing. This is **not** the Flathub build pipeline. |
+
+**Application ID:** the manifest uses `org.scantailor.Advanced` so it does **not** replace the legacy `com.github._4lex4.*` Flatpak. Author docs: [for app authors](https://docs.flathub.org/docs/for-app-authors/).
 
 **Community examples / test data:** See also [scantailor-testing](https://github.com/ImageProcessing-ElectronicPublications/scantailor-testing) (community repository; issue [#43](https://github.com/ScanTailor-Advanced/scantailor-advanced/issues/43)).
 

flatpak/org.scantailor.Advanced.json

@@ -1,10 +1,8 @@
 {
   "id": "org.scantailor.Advanced",
   "runtime": "org.kde.Platform",
-  "runtime-version": "5.15-22.08",
+  "runtime-version": "5.15-24.08",
   "sdk": "org.kde.Sdk",
-  "base": "org.kde.Sdk",
-  "base-version": "5.15-22.08",
   "command": "scantailor",
   "finish-args": [
     "--share=ipc",