Setup Shorebird

Installs and sets up Shorebird for use in GitHub Actions.

Features

✅ Downloads the Shorebird CLI

✅ Adds shorebird to the system path

✅ Configures the specified version of Flutter

✅ Optionally cache the Shorebird installation

Inputs

• cache: Cache the Shorebird installation and artifacts. Default: false
• shorebird-version: Not recommended. Pins the Shorebird CLI release to install (the version shorebird --version prints, e.g. 1.6.125; this is not a Flutter version). Defaults to the latest stable release.
  • Pinning is likely to break over time: Shorebird's servers require newer CLI versions as they evolve, so an old pinned version will eventually be rejected. It exists for those who need it.
  • To build with a specific Flutter version, pass --flutter-version to shorebird release instead. That is supported and doesn't require pinning the CLI.

Usage

steps:
  - uses: shorebirdtech/setup-shorebird@v1
    with:
      cache: true # Optionally cache the Shorebird installation
  - run: shorebird --version