Shorebird Release

Create a new release using the Shorebird CLI for use in GitHub Actions.

Features

✅ Create new releases for iOS, Android, macOS, Linux, and Windows

✅ Outputs the release version

Usage

Standard usage:

steps:
  - uses: shorebirdtech/setup-shorebird@v1
  - uses: shorebirdtech/shorebird-release@v1
    id: shorebird-release
    with:
      flutter-version: latest
      platform: android
      working-directory: ./path/to/app

  - run: echo release-version ${{ steps.shorebird-release.outputs.release-version }}
    shell: bash

If you need to provide arguments to the release command, you can do so like this:

steps:
  - uses: shorebirdtech/setup-shorebird@v1
  - uses: shorebirdtech/shorebird-release@v1
    id: shorebird-release
    with:
      # Use >- to strip newlines if passing args across multiple lines.
      args: >-
        --verbose
        --flavor=my-flavor
        --target=lib/special_main.dart
      flutter-version: 3.29.2
      platform: android
      working-directory: ./path/to/app

Inputs

The action takes the following inputs:

• args: Any arguments to pass to shorebird release. For example, if you need to specify a flavor, you can pass --flavor=<FLAVOR>.
  • Use an extra -- to pass arguments to Flutter (e.g. -- --dart-define=KEY=VALUE)
• flutter-version: Which Flutter version to build the release with
  • Use latest if you want to always target the latest stable version of Flutter support by Shorebird.
• platform: Which platform to create a release for (e.g. android or ios)
• working-directory: Which directory to run shorebird release in.

Outputs

The actions outputs the following:

• release-version: The version of the release that was successfully created.