Publish from GitHub Actions

The Flitz GitHub Actions install the CLI and the SDK your project pins on a GitHub-hosted runner, run flitz publish, and comment on the pull request with a link to the build. Each pull request then carries a preview that your team can open on a real device while they review it.

Prerequisites

• The project pins an SDK in a committed flitz.yaml (flitz sdk use).
• The organization API key is stored as a repository secret, for example FLITZ_APIKEY (Settings → Secrets and variables → Actions). Create the key on the Settings page of the portal or with flitz apikey create.
• A supported runner: Linux x64 (ubuntu-latest) or Apple-silicon macOS (macos-latest). Every other runner fails on the first step.

Publish every pull request

name: Flitz preview

on: pull_request

concurrency:
  group: flitz-preview-${{ github.event.pull_request.number }}
  cancel-in-progress: true

permissions:
  contents: read
  pull-requests: write

jobs:
  preview:
    runs-on: ubuntu-latest
    # Pull requests from forks get no secrets.
    if: github.event.pull_request.head.repo.full_name == github.repository
    steps:
      - uses: actions/checkout@v7
      - uses: leancodepl/flitz-actions@main
        with:
          api-key: ${{ secrets.FLITZ_APIKEY }}

• pull-requests: write lets the action post its comment. On a push or a manual run it publishes and posts nothing.
• @main follows the newest version of the actions. To choose when you take updates, pin a commit SHA instead.

The action:

1. Installs the newest CLI and the SDK that flitz.yaml pins, and caches the SDK and your pub dependencies between runs.
2. Runs flitz publish --yes --json in the folder that holds flitz.yaml. --yes downloads the SDK on a cold cache and creates the app when flitz.yaml names one your organization does not have yet.
3. Labels the publish in the publish history: PR #<number>: <title> as its name, pr-<number>-<short sha> as its version name, and the pull request, the commit, and the run as its comment. Values over the CLI's limits are trimmed, with a warning.
4. Adds the links to the run's summary page, and comments on the pull request with a link to the landing page. The deeplink, the bundle link, the publish ID, and the commit are in a collapsed Details block. Each run replaces the action's previous comment, so the pull request shows one current preview.

The publish lands on the track of the pull request's branch, or of the pushed branch on a push. The app is the one flitz.yaml names with app:, or your pubspec name:. The action has no input for the app key or the track; set them in flitz.yaml when the defaults do not fit.

Inputs

The action's outputs include page-url, deeplink, bundle-url, and id — the fields of the publish result — and comment-url.

For a monorepo app with its own flitz.yaml, a flavor entry point, and a compile-time constant:

- uses: leancodepl/flitz-actions@main
  with:
    api-key: ${{ secrets.FLITZ_APIKEY }}
    flitz-path: mobile/flitz.yaml
    target: lib/main_staging.dart
    dart-define: |
      API_URL=https://staging.example.com
    pr-comment-message: Open it in the staging build of the app.

Compose the steps yourself

The combined action is three smaller ones, which you can use separately — for example, to run your tests before anything is published:

- uses: leancodepl/flitz-actions/install@main
  with:
    api-key: ${{ secrets.FLITZ_APIKEY }}
- run: flutter test
- id: flitz
  uses: leancodepl/flitz-actions/publish@main
  with:
    api-key: ${{ secrets.FLITZ_APIKEY }}
- uses: leancodepl/flitz-actions/pr-comment@main
  with:
    page-url: ${{ steps.flitz.outputs.page-url }}
    deeplink: ${{ steps.flitz.outputs.deeplink }}
    bundle-url: ${{ steps.flitz.outputs.bundle-url }}
    id: ${{ steps.flitz.outputs.id }}

A flitz command you run in your own step needs the key in its environment, FLITZ_APIKEY: ${{ secrets.FLITZ_APIKEY }}: no action exports it. The actions mask the key in the log and pass it only to the steps that run flitz.

Troubleshooting

Everything else fails as flitz publish does on your own machine, with the same message and exit code; see CLI troubleshooting and Exit codes.