Files
soundcraft/packaging/linux/flatpak/ai.storyteller.soundcraft.yml
8115ba9ed5 Release: Flatpak x86_64/aarch64, AppImage zsync updates, README Downloads (#13)
- AppImages embed gh-releases-zsync update information and ship a .zsync beside them.
- New flatpak job repackages the Linux tarball into soundcraft-<v>-linux-<arch>.flatpak
  (bundle manifest + flatpak-bundle.sh). Sandbox: pulseaudio socket (PipeWire's pulse server),
  ~/.vst3 and ~/.clap read-only, the LinuxAudio.Plugins extension point via VST3_PATH/CLAP_PATH;
  no raw ALSA devices, no JACK. The from-source Flathub manifest gets the same finish-args.
- Only signing jobs (macOS, Windows) and the draft job keep `environment: release`, so a branch
  dispatch dry-runs Linux, Flatpak, FreeBSD and web; the draft job still needs the signed jobs.
- README: Downloads section; docs/releasing.md updated.

Co-authored-by: Brandon Thomas <shared2@storyteller.ai>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 09:34:50 -04:00

96 lines
4.8 KiB
YAML

# Flatpak manifest for SoundCraft, ready for a Flathub submission.
#
# Flatpak builds run offline, so the crate sources must be vendored first. From the repo root:
#
# curl -fsSLO https://raw.githubusercontent.com/flatpak/flatpak-builder-tools/master/cargo/flatpak-cargo-generator.py
# python3 flatpak-cargo-generator.py Cargo.lock -o packaging/linux/flatpak/cargo-sources.json
# flatpak-builder --user --install --force-clean build-flatpak packaging/linux/flatpak/ai.storyteller.soundcraft.yml
# flatpak run ai.storyteller.soundcraft
#
# For Flathub, replace the `dir` source with a `git` source pinned to a release tag and commit.
# ai.storyteller.soundcraft.bundle.yml repackages the release tarball into the .flatpak attached
# to each GitHub release; keep runtime-version, finish-args and add-extensions identical in both
# (packaging-lint checks this).
#
# Audio: cpal talks to ALSA. alsa-lib (headers in the Sdk, the library in the Platform) and its
# PulseAudio plugin ship with the freedesktop runtime, which routes ALSA through the PulseAudio
# socket (PipeWire's pulse server on modern desktops), so no extra module is needed.
id: ai.storyteller.soundcraft
runtime: org.freedesktop.Platform
runtime-version: '25.08'
sdk: org.freedesktop.Sdk
sdk-extensions:
- org.freedesktop.Sdk.Extension.rust-stable
command: soundcraft
finish-args:
# Display: Wayland first; X11 only when no Wayland compositor is running.
- --socket=wayland
- --socket=fallback-x11
# X11 shared memory (MIT-SHM). Without it the X11 fallback is slow or fails.
- --share=ipc
# GPU access for the wgpu UI (Vulkan, or GL as a fallback).
- --device=dri
# Playback and recording. cpal talks to ALSA; the runtime's alsa-lib routes ALSA through its
# PulseAudio plugin to this socket, which PipeWire's pulse server provides on modern desktops
# (and PulseAudio itself on older ones). Deliberately not granted: --device=all (raw /dev/snd
# for direct ALSA hardware access, which would bypass the sound server) and JACK, which
# SoundCraft doesn't use (cpal's jack feature is off; there is no live MIDI I/O either).
- --socket=pulseaudio
# Open/Save dialogs use the file-chooser portal (rfd) and drag-and-drop the document portal,
# so broad filesystem access isn't needed. Music is granted for sessions and their
# "Audio Files" folders opened by path from the command line.
- --filesystem=xdg-music
# VST3 and CLAP plugin hosts. The per-user plugin folders the hosts scan, read-only.
# System folders (/usr/lib/vst3, /usr/lib/clap) aren't reachable from the sandbox, and plugins
# there are linked against the host's libraries rather than the runtime's; sandboxed plugins
# come from Flatpak extensions instead (add-extensions below), found through these paths.
- --filesystem=~/.vst3:ro
- --filesystem=~/.clap:ro
- --env=VST3_PATH=/app/extensions/Plugins/vst3
- --env=CLAP_PATH=/app/extensions/Plugins/clap
# Flathub's shared audio-plugin extension point (org.freedesktop.LinuxAudio.Plugins.*, the one
# Ardour, Bitwig and friends use). Optional: nothing is downloaded unless the user installs a
# plugin extension; merge-dirs lets every installed one appear under .../Plugins/{vst3,clap}.
add-extensions:
org.freedesktop.LinuxAudio.Plugins:
directory: extensions/Plugins
version: '25.08'
add-ld-path: lib
merge-dirs: vst3;clap
subdirectories: true
no-autodownload: true
build-options:
append-path: /usr/lib/sdk/rust-stable/bin
modules:
- name: soundcraft
buildsystem: simple
build-options:
env:
CARGO_HOME: /run/build/soundcraft/cargo
CARGO_NET_OFFLINE: 'true'
build-commands:
- cargo --offline build --release --locked -p soundcraft -p soundcraft-cli
- install -Dm755 target/release/soundcraft /app/bin/soundcraft
- install -Dm755 target/release/soundcraft-cli /app/bin/soundcraft-cli
- install -Dm644 packaging/linux/ai.storyteller.soundcraft.desktop /app/share/applications/ai.storyteller.soundcraft.desktop
- install -Dm644 packaging/linux/ai.storyteller.soundcraft.mime.xml /app/share/mime/packages/ai.storyteller.soundcraft.xml
- mkdir -p /app/share/icons && cp -R assets/app-icon/hicolor /app/share/icons/
- >-
version=$(awk '/^\[/{p=($0=="[workspace.package]");next} p&&$1=="version"{gsub(/[" ]/,"",$3);print $3;exit}' Cargo.toml);
install -d /app/share/metainfo;
sed -e "s/@VERSION@/$version/" -e "s/@DATE@/$(date -u +%Y-%m-%d)/"
packaging/linux/ai.storyteller.soundcraft.metainfo.xml.in > /app/share/metainfo/ai.storyteller.soundcraft.metainfo.xml
# Mount point for the plugin extensions (add-extensions).
- install -d /app/extensions/Plugins
sources:
- type: dir
path: ../../..
skip:
- target
- dist
- corpus
- plan
- build-flatpak
- .flatpak-builder
- cargo-sources.json