Prepare repo for Flathub build process (#2093)

* Removed logic to build/release a standalone flatpak file

* Add flatpal-node-generator workflow to create flatpak manifest module sources

* Added script to skip packaging when building

* Added flatpak check to auto updater for safety

* Updated flatpak-node-generator workflow to publish sources to releases over workflow artifacts

* Removed workflow dispatch from flatpak-node-generator

* Add main field to package.json pointing to electron-main.ts

* Added images to docs folder for appstream metadata

* Added yarn release and yarn path to have a consistent yarn version as long as yarn is installed - likely best way for flathub ci to use the right version

* Updated build-unpackaged to be more clear and include electron binaries

* Fix env var naming difference in quasar config

* Reverted script name to unpacked to align with electron-builder

* Updated build unpacked script to specify linux

* Removed main from package.json

* Fixed import quotes in quasar config

* Updated all quotes to single quotes in quasar config

* Added flatpak files to main repo

* Removed yarn release from repo

* Update flatpak node generator to commit updated file directly to repo

* Added commit message to flatpak-node-generator

* Updated flatpak-node-generator workflow to run on pushes where lockfile is changed

* Added extra workflow dispatch to flatpak-node-generator workflow

* Update flatpak/generated-sources.json

* Removed .yarn dir and updated workflow to only commit generated sources.json

* Updated manifest to include its own yarn source

* Changed the current manifest to a template and added a manifest generator to generate a different manifest for local dev vs releasing

* Added scripts to generate the manifest

* Updated manifest tooling to have default manifest in repo, and generate the release manifest

* Added flatpak job to release workflow to create flatpak release and upload it

* Fix git error in release workflow hopefully

* Updated flatpak/README.md

* Updated flatpak/readme to include info on script

* Fixed formatting in release workflow

* Added build flatpak workflow to ensure flatpak builds

* Added comments to flatpak-node-generator workflow

* Fixed YAML.parse to be in try catch

* Updated gitignore

* Replaced install-flatpak command with build-flatpak, and added flatpak builder helper scripts

* Update flatpak/generated-sources.json

* Removed electron-installer-flatpak dependency

* Update flatpak/generated-sources.json

* Delete flatpak/generated-sources.json

* updated gitignore

* Updated mise.toml to include pipx

* added running flatpak-node-generator yarn script to generate sources

* remove workflow

* Update building.md

* Added script to install flatpak-node-generator

* Update build/release workflows

* Add uv to mise to install flatpak-node-generator

* fixed flatpak-node-generator to use uv version

* updated flatpak building ci to use lighter base image

* Removed explicit uv tool install in favor of just using uvx

* add test commands to build-flatpak workflow

* updated test commands for build-flatpak workflow

* removed testing from build-flatpak workflow

* Try pinning flatpak-node-generator version

* test debug step

* more workflow testing

* even more ci testing

* fix attempt for flatpak-node-generator version being wrong

* more workflow debugging

* more workflow debugging p2

* final testing solution for workflow

* reenable cache in flatpak build workflow

* add python as mise dep that auto installs pipx

* update yarn script to use pipx

* add --install-deps-from flag to build-flatpak-repo script

* Revert workflow images to gnome based

* fix typo in container tag

* Revert workflows to offload building process to flatpak builder action

* updated documentation files

* Update flatpak/README.md

* Update generate-release-manifest.js to find the local directory block instead of always replacing the first source

* Added flatpak release steps

* Updated finish args and meta info for having host filesystem access

* fixed script name in error log

* Update yarn lock to fix weird dependency differences

Author: TB516

.github/workflows/build-flatpak.yml

@@ -0,0 +1,35 @@
+name: Build Flatpak
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build-flatpak:
+    name: Build the Flatpak app
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/flathub-infra/flatpak-github-actions:freedesktop-25.08
+      options: --privileged
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: jdx/mise-action@v3
+        with:
+          install: true
+          cache: true
+          log_level: debug
+
+      - name: Install Yarn dependencies
+        run: yarn install --immutable
+
+      - name: Generate release manifest
+        run: yarn generate-release-manifest
+
+      - name: Generate node sources
+        run: yarn generate-node-sources
+
+      - name: Build flatpak
+        uses: flatpak/flatpak-github-actions/flatpak-builder@v6
+        with:
+          bundle: r2modman.flatpak
+          manifest-path: flatpak/io.github.ebkr.r2modman.release.yaml

.github/workflows/build.yml

@@ -16,9 +16,6 @@ jobs:
           - kind: windows
             os: windows-latest
             platform: win
-          - kind: flatpak
-            os: ubuntu-latest
-            platform: flatpak
           # Macos-11 is deprecated, macos-12 would require package updates, see PR #1409
           # - kind: mac
           #   os: macos-11
@@ -35,27 +32,12 @@ jobs:
       - name: Install Yarn dependencies
         run: yarn install --immutable
 
-      - if: matrix.platform == 'linux' || matrix.platform == 'flatpak'
+      - if: matrix.platform == 'linux'
         name: Install bsdtar # Required by electron-builder when targeting pacman.
         run: |
           sudo apt-get update -y
           sudo apt-get install -y libarchive-tools
 
-      - if: matrix.platform == 'flatpak'
-        name: Cache Flatpak runtimes
-        uses: actions/cache@v4
-        with:
-          path: ~/.local/share/flatpak
-          key: flatpak-${{ runner.os }}-25.08
-
-      - if: matrix.platform == 'flatpak'
-        name: Install Flatpak and flatpak-builder
-        run: |
-          sudo apt-get install -y flatpak flatpak-builder
-          flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
-          flatpak install --user -y flathub org.freedesktop.Platform//25.08 org.freedesktop.Sdk//25.08
-          flatpak install --user -y flathub org.electronjs.Electron2.BaseApp//25.08
-
       - name: Build project
         id: build
         uses: StarUbiquitous/command-output@v1.0.1 # Store stdout/stderr to outputs.
@@ -82,5 +64,5 @@ jobs:
         name: Upload artifacts
         uses: actions/upload-artifact@v6
         with:
-          path: 'dist/electron/Packaged'
-          name: 'r2modman-${{ matrix.platform }}-build-${{ github.sha }}'
+          path: "dist/electron/Packaged"
+          name: "r2modman-${{ matrix.platform }}-build-${{ github.sha }}"

.github/workflows/release.yml

@@ -17,9 +17,6 @@ jobs:
           - kind: windows
             os: windows-latest
             platform: win
-          - kind: flatpak
-            os: ubuntu-latest
-            platform: flatpak
     steps:
       - uses: actions/checkout@v4
 
@@ -32,28 +29,12 @@ jobs:
       - name: Install Yarn dependencies
         run: yarn install --immutable
 
-      - if: matrix.platform == 'linux' || matrix.platform == 'flatpak'
+      - if: matrix.platform == 'linux'
         name: Install bsdtar # Required by electron-builder when targeting pacman.
         run: |
           sudo apt-get update -y
           sudo apt-get install -y libarchive-tools
 
-      - if: matrix.platform == 'flatpak'
-        name: Cache Flatpak runtimes
-        uses: actions/cache@v4
-        with:
-          path: ~/.local/share/flatpak
-          key: flatpak-${{ runner.os }}-25.08
-
-      - if: matrix.platform == 'flatpak'
-        name: Install Flatpak and flatpak-builder
-        run: |
-          sudo apt-get install -y flatpak flatpak-builder
-          flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
-          flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
-          flatpak install --user -y flathub org.freedesktop.Platform//25.08 org.freedesktop.Sdk//25.08
-          flatpak install --user -y flathub org.electronjs.Electron2.BaseApp//25.08
-
       - name: Release project
         id: build
         uses: StarUbiquitous/command-output@v1.0.1
@@ -74,3 +55,50 @@ jobs:
         uses: actions/github-script@v6
         with:
           script: core.setFailed('It seems the build process failed silently. See previous step for more info.')
+
+  release-flatpak:
+    name: Release for Flatpak
+    needs: release
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/flathub-infra/flatpak-github-actions:freedesktop-25.08
+      options: --privileged
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: jdx/mise-action@v3
+        with:
+          install: true
+          cache: true
+          log_level: debug
+
+      - name: Install Yarn dependencies
+        run: yarn install --immutable
+
+      - name: Generate release manifest
+        run: yarn generate-release-manifest
+
+      - name: Generate node sources
+        run: yarn generate-node-sources
+
+      - name: Build flatpak
+        uses: flatpak/flatpak-github-actions/flatpak-builder@v6
+        with:
+          bundle: r2modman.flatpak
+          manifest-path: flatpak/io.github.ebkr.r2modman.release.yaml
+
+      - name: Compute release tag
+        id: tag
+        run: echo "tag=v$(node -p "require('./package.json').version")" >> "$GITHUB_OUTPUT"
+
+      - name: Mark checkout as safe for git
+        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
+      - name: Append standalone flatpak to release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TAG_NAME: ${{ steps.tag.outputs.tag }}
+        run: |
+          gh release upload "$TAG_NAME" r2modman.flatpak --clobber

.gitignore

@@ -18,6 +18,13 @@ yarn-error.log*
 log.txt
 .env.json
 
+flatpak/io.github.ebkr.r2modman.release.yaml
+flatpak/repo
+flatpak/build
+.flatpak-builder
+flatpak/r2modman.flatpak
+flatpak/generated-sources.json
+
 # Editor directories and files
 .idea
 .vscode

BUILDING.md

@@ -4,6 +4,7 @@
 - Yarn
 - Quasar CLI (Install using `yarn global add @quasar/cli`)
 - Python 2
+- pipx/flatpak-node-generator (if doing a local flatpak build)
 
 #### Linux Build
 - rpm builder