Shorebird Deployment

📄 Shorebird Deployment Documentation

Shorebird enables seamless over-the-air (OTA) updates for Flutter apps. This documentation outlines how to release and patch your Flutter Android app using Shorebird.


✅ Prerequisites

  • Flutter SDK installed

  • Shorebird CLI installed:

    curl -s https://releases.shorebird.dev/install.sh | bash
    
  • Shorebird account set up and app initialized:

    shorebird login
    shorebird init
    

🚀 Releasing a New Version

To publish a new release of your Android app:

shorebird release android --flutter-version 3.22.3 --artifact=apk

Parameters:

  • --flutter-version: Specifies the Flutter version used in the release.

  • --artifact=apk: Indicates that the release artifact is an Android APK.

📦 This will upload a new release to Shorebird with the specified Flutter version.


🩹 Creating a Patch

To push an OTA update (patch) to an existing release:

shorebird patch --platforms=android --release-version=1.0.60+60

Parameters:

  • --platforms=android: Specifies that the patch targets the Android platform.

  • --release-version=1.0.60+60: Identifies the release version you want to patch.

🛠️ Ensure that the changes are backward compatible and tested before patching.


🔍 Additional Commands

  • Check Shorebird version:

    shorebird --version
    
  • View release history:

    shorebird releases
    

📚 Resources

On this page