FrogPak

Feeding a Pond #

A Pond needs one thing from an app: a release whose files it can match, one .flatpak bundle per architecture. How the bundles are built is up to the app's developer. There are three ways to provide them.

1. FrogPak releaser #

FrogPak/releaser is a workflow you add to the app repository. It builds the bundles for x86_64 and aarch64, checks that versions agree, publishes the release when the version in your metainfo changes, and triggers your Ponds. Its README has the details.

Its bundles use the default names, so the Pond entry needs only repo.

2. Your own workflow, with a trigger #

Keep your build and add one step after a release is published, so Ponds update at once:

- name: Trigger Ponds
  if: ${{ !contains(github.ref_name, '-') }}
  env:
    GH_TOKEN: ${{ secrets.POND_TOKEN }}
  run: gh workflow run publish.yml --repo OWNER/POND

The if skips pre-releases, which Ponds ignore. Set assets in the Pond's entry if your file names differ from {app_id}-{arch}.flatpak.

3. Your own workflow, no trigger #

Nothing to add. The Pond finds the release at its next hourly check.

Apps released on Codeberg, Forgejo or Gitea use option 3, or option 2 by running the same gh command from their own CI. GitLab support is planned.

Triggering a Pond #

A trigger starts the Pond's normal check early; a trigger with nothing new costs one quick check.

POND_TOKEN is a fine-grained personal access token, created by someone with write access to the Pond:

  1. GitHub Settings > Developer settings > Personal access tokens > Fine-grained tokens > Generate new token.
  2. Resource owner: the Pond's owner. Repository access: only the Pond repository.
  3. Permissions > Actions: Read and write. Nothing else.
  4. Add the token to the app repository as an Actions secret named POND_TOKEN.

The token can only start the Pond's workflows. A Pond owned by an organization may require the organization to allow fine-grained tokens first.

Release files #