Fix flatpak packaging to a working state #6678

alaviss · 2025-03-12T08:54:56Z

This should make testing Flatpak builds a lot easier.

To build, enter flatpak/ directory and run:

flatpak-builder --repo=repo builddir com.mitchellh.ghostty.yml

alternatively, using org.flatpak.Builder flatpak:

flatpak run -p org.flatpak.Builder \
  --repo=repo \
  builddir \
  com.mitchellh.ghostty.yml

The resulting flatpak can be installed using

flatpak install ./repo com.mitchellh.ghostty

Credit of AppStream metadata goes to @yorickpeterse.

flatpak/com.mitchellh.ghostty.yml

dist/linux/com.mitchellh.ghostty.metainfo.xml

flatpak/com.mitchellh.ghostty.yml

flatpak/com.mitchellh.ghostty.Devel.yml

dist/linux/com.mitchellh.ghostty.metainfo.xml

flatpak/dependencies.yml

alaviss · 2025-03-15T02:59:21Z

Rebased to Zig 0.14.0.

Due to #6734 ~~and #6733~~, flatpak-builder will not be able to build Ghostty at the moment.

alaviss · 2025-03-16T18:06:04Z

Rebased to main, flatpak build is now fully functional.

tulilirockz · 2025-03-16T18:31:01Z

dist/linux/com.mitchellh.ghostty.metainfo.xml

+  <!--
+    TODO: Generate manifest location data.
+
+    Ref: https://docs.flathub.org/docs/for-app-authors/metainfo-guidelines#manifest-location
+
+  <custom>
+    <value key="flathub::manifest">https://github.com/ghostty-org/ghostty/blob/<hash>/flatpak/com.mitchellh.ghostty.yml</value>
+  </custom>
+  -->


This isnt enforced by the flathub review process. At least I havent ran into this at all when publishing flatpak manifests to Flathub

It sounds like a requirement if you're publishing straight from here to Flathub, though. At least I see that Firefox and OBS are following it.

mitchellh · 2025-03-19T19:31:56Z

I'm trying to verify this so we can get it merged but I'm getting build errors locally:

Cache miss, checking out last cache hit
========================================================================
Building module ghostty in /home/mitchellh/code/go/src/github.com/ghostty-org/ghostty/flatpak/.flatpak-builder/build/ghostty-2
========================================================================
Updated Git hooks.
Git LFS initialized.
Note: switching to '4182b7fa42f27cf14a71dbdb54cfd82c5c6e3447'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 4182b7f switch zigimg ref to merged commit
Updated Git hooks.
Git LFS initialized.
Note: switching to '4a002763419a34d61dcbb1f415821b83b9bf8ddc'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 4a00276 Merge pull request 'fix removed b.host on v0.14.0-dev.2568+42dac40b3' (#25) from e0328eric/zg:master into master
Updated Git hooks.
Git LFS initialized.
fatal: unable to read tree (0ce4eca3560d5553b13263d6b6bb72e146dd43d0)
Error: module ghostty: Child process exited with code 128

Any ideas?

alaviss · 2025-03-19T19:41:12Z

fatal: unable to read tree (0ce4eca3560d5553b13263d6b6bb72e146dd43d0)

Looks like it's zigimg again.

They force pushed their master branch so now the commit referenced is unreachable from default branch.

Maybe I'll have to fix the cache gen script to prefer downloading archives instead...

alaviss · 2025-03-21T07:21:10Z

Rebased and fixed the issue with zigimg. The flatpak should build correctly now.

alaviss · 2025-03-24T16:00:47Z

Rebased to main and updated package cache.

alaviss · 2025-03-30T03:44:25Z

Rebased to main and dropped zigimg workaround, given that the fork's author committed to stop force pushing.

yorickpeterse · 2025-04-16T21:40:30Z

Is there anything that's holding back this PR (or reviewing of it)? 😃

00-kat · 2025-04-16T22:15:52Z

To quote Mitchell from Discord:

Its on me, I was ready to merge it before and just couldn't make it work locally. I have to run this locally to make sure it all works (so I can debug it one day if it doesn't) and then we hsould be good to go.

mitchellh · 2025-04-22T17:31:37Z

Okay hurray the build works for me. I want to add some CI checks next and we should be good. CI may be annoying though lets see!

tulilirockz · 2025-04-22T17:39:27Z

Flathub recently moved to github workflows for CI, maybe there would be something useful there?

mitchellh · 2025-04-22T17:53:17Z

Okay, a couple important CI failures and I'm not quite sure what they are yet:

For some reason check-zig-cache.sh works on my local system (with Nix) but not in CI.
Seeing a strange failure about lazy dependencies here: https://github.com/ghostty-org/ghostty/actions/runs/14601245977/job/40959653302

If anyone has ideas, that's blocking this, because we need CI to make sure this doesn't bitrot.

alaviss · 2025-04-22T17:55:31Z

For some reason check-zig-cache.sh works on my local system (with Nix) but not in CI.

It's correct to fail, the lock file in main changed between the last rebase and now (and GHA runs on the merged head of main and this PR).
You'd have to merge main into this and update the deps.

@yorickpeterse

This should make testing Flatpak builds a lot easier. To build, enter `flatpak/` directory and run: flatpak-builder --repo=repo builddir com.mitchellh.ghostty.yml alternatively, using org.flatpak.Builder flatpak: flatpak run -p org.flatpak.Builder \ --repo=repo \ builddir \ com.mitchellh.ghostty.yml The resulting flatpak can be installed using flatpak install ./repo com.mitchellh.ghostty Credit of AppStream metadata goes to @yorickpeterse.

Flatpak will strip them out on its own into an extension package, useful for debugging

This variant is built in Debug mode and is given a different desktop file so it could be installed side-by-side with regular Ghostty.

* Added URLs to more resources * Fixed developer ID * Added device compatibility information

mitchellh · 2025-04-22T17:57:49Z

Good catch, trying again.

alaviss · 2025-04-22T18:05:36Z

It might be useful to also build the .Devel variant for debugging purposes, but I don't know if Flatpak GHA uploads debuginfo.

mitchellh · 2025-04-22T18:45:51Z

Thanks, CI looks good! I'm going to polish up the runs and dependencies a bit and we should b good

mitchellh

Thanks for sticking with this PR. With the Flatpak build being verified in CI now this should help keep everything much more stable. 😄

flatpak/build-support/check-zig-cache.sh

@yorickpeterse

This should make testing Flatpak builds a lot easier. To build, enter `flatpak/` directory and run: flatpak-builder --repo=repo builddir com.mitchellh.ghostty.yml alternatively, using org.flatpak.Builder flatpak: flatpak run -p org.flatpak.Builder \ --repo=repo \ builddir \ com.mitchellh.ghostty.yml The resulting flatpak can be installed using flatpak install ./repo com.mitchellh.ghostty Credit of AppStream metadata goes to @yorickpeterse.

@yorickpeterse

This should make testing Flatpak builds a lot easier. To build, enter `flatpak/` directory and run: flatpak-builder --repo=repo builddir com.mitchellh.ghostty.yml alternatively, using org.flatpak.Builder flatpak: flatpak run -p org.flatpak.Builder \ --repo=repo \ builddir \ com.mitchellh.ghostty.yml The resulting flatpak can be installed using flatpak install ./repo com.mitchellh.ghostty Credit of AppStream metadata goes to @yorickpeterse.

alaviss requested a review from a team as a code owner March 12, 2025 08:54

yorickpeterse reviewed Mar 12, 2025

View reviewed changes

flatpak/com.mitchellh.ghostty.yml Outdated Show resolved Hide resolved

yorickpeterse reviewed Mar 12, 2025

View reviewed changes

flatpak/com.mitchellh.ghostty.yml Show resolved Hide resolved

yorickpeterse reviewed Mar 12, 2025

View reviewed changes

flatpak/com.mitchellh.ghostty.yml Show resolved Hide resolved

tristan957 reviewed Mar 12, 2025

View reviewed changes

dist/linux/com.mitchellh.ghostty.metainfo.xml Show resolved Hide resolved

tristan957 reviewed Mar 12, 2025

View reviewed changes

flatpak/com.mitchellh.ghostty.yml Outdated Show resolved Hide resolved

pluiedev added os/linux packaging labels Mar 12, 2025

tristan957 reviewed Mar 12, 2025

View reviewed changes

flatpak/com.mitchellh.ghostty.Devel.yml Outdated Show resolved Hide resolved

alaviss force-pushed the push-qwtptnnownso branch from f4c1020 to 3284ae5 Compare March 12, 2025 22:24

alaviss commented Mar 13, 2025

View reviewed changes

dist/linux/com.mitchellh.ghostty.metainfo.xml Show resolved Hide resolved

alaviss force-pushed the push-qwtptnnownso branch from 2b4716b to dfbfdc3 Compare March 13, 2025 00:38

00-kat mentioned this pull request Mar 13, 2025

feat: add appstream metadata for linux packages #6688

Closed

tulilirockz reviewed Mar 13, 2025

View reviewed changes

flatpak/dependencies.yml Outdated Show resolved Hide resolved

alaviss mentioned this pull request Mar 15, 2025

update zon2nix #6728

Merged

alaviss force-pushed the push-qwtptnnownso branch from 0be3824 to 7276f07 Compare March 15, 2025 02:58

alaviss force-pushed the push-qwtptnnownso branch 3 times, most recently from 7fdbf01 to a037432 Compare March 16, 2025 18:05

tulilirockz reviewed Mar 16, 2025

View reviewed changes

alaviss force-pushed the push-qwtptnnownso branch from a037432 to 7e387a6 Compare March 21, 2025 07:19

alaviss force-pushed the push-qwtptnnownso branch from 05a6719 to a878247 Compare March 24, 2025 15:59

alaviss force-pushed the push-qwtptnnownso branch 2 times, most recently from 6b436db to e20e99b Compare March 30, 2025 03:44

mitchellh force-pushed the push-qwtptnnownso branch from 9de1edd to 0f69195 Compare April 22, 2025 17:46

alaviss and others added 7 commits April 22, 2025 10:56

flatpak: keep debug info for ghostty itself

3232cfe

Flatpak will strip them out on its own into an extension package, useful for debugging

flatpak: add development variant

9de1aad

This variant is built in Debug mode and is given a different desktop file so it could be installed side-by-side with regular Ghostty.

metainfo: update with extra data

0473b0c

* Added URLs to more resources * Fixed developer ID * Added device compatibility information

flatpak: use archive for gtk4-layer-shell

7c1e682

prettier

3e81006

ci: flatpak

d7256c7

mitchellh force-pushed the push-qwtptnnownso branch from 0f69195 to 1fa78e7 Compare April 22, 2025 17:56

update flatpak build hash

946cf5a

mitchellh force-pushed the push-qwtptnnownso branch from 1fa78e7 to 946cf5a Compare April 22, 2025 17:57

ci: fix up flatpak deps

e6c2105

mitchellh approved these changes Apr 22, 2025

View reviewed changes

flatpak/build-support/check-zig-cache.sh Show resolved Hide resolved

mitchellh enabled auto-merge April 22, 2025 19:03

mitchellh merged commit f5b5a36 into ghostty-org:main Apr 22, 2025
38 checks passed

github-actions bot added this to the 1.2.0 milestone Apr 22, 2025

alaviss deleted the push-qwtptnnownso branch April 22, 2025 19:24

Fix flatpak packaging to a working state #6678

Fix flatpak packaging to a working state #6678

Uh oh!

Conversation

alaviss commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alaviss commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alaviss commented Mar 16, 2025

Uh oh!

tulilirockz Mar 16, 2025

Choose a reason for hiding this comment

Uh oh!

alaviss Mar 16, 2025

Choose a reason for hiding this comment

Uh oh!

mitchellh commented Mar 19, 2025

Uh oh!

alaviss commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alaviss commented Mar 21, 2025

Uh oh!

alaviss commented Mar 24, 2025

Uh oh!

alaviss commented Mar 30, 2025

Uh oh!

yorickpeterse commented Apr 16, 2025

Uh oh!

00-kat commented Apr 16, 2025

Uh oh!

mitchellh commented Apr 22, 2025

Uh oh!

tulilirockz commented Apr 22, 2025

Uh oh!

mitchellh commented Apr 22, 2025

Uh oh!

alaviss commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mitchellh commented Apr 22, 2025

Uh oh!

alaviss commented Apr 22, 2025

Uh oh!

mitchellh commented Apr 22, 2025

Uh oh!

mitchellh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alaviss commented Mar 12, 2025 •

edited

Loading

alaviss commented Mar 15, 2025 •

edited

Loading

alaviss commented Mar 19, 2025 •

edited

Loading

alaviss commented Apr 22, 2025 •

edited

Loading