Getting Started

Flutter Distributor is an all-in-one Flutter application packaging and distribution tool, providing you with a one-stop solution to meet various distribution needs.

Installation

dart pub global activate flutter_distributor

Usage

Add distribute_options.yaml to your project root directory.

output: dist/

Configure A Publisher

Let’s take pgyer as an example, after logging in, click the user avatar on the right side to go to the API information page from the menu, copy the API Key and add it to the env node.

variables:
  PGYER_API_KEY: "your api key"

Check out the Publishers documentation for all possible publishers and how to configure them.

Configure Release Items

The following example shows how to add a release that contains package apk, ipa and publish to pgyer.com, A release can include multiple jobs.

The build_args are the args supported by the flutter build command, please modify it according to your project.

releases:
  - name: dev
    jobs:
      # Build and publish your apk pkg to pgyer
      - name: release-dev-android
        package:
          platform: android
          target: apk
          build_args:
            flavor: dev
            target-platform: android-arm,android-arm64
            dart-define:
              APP_ENV: dev
        publish_to: pgyer
      # Build and publish your ipa pkg to pgyer
      - name: release-dev-ios
        package:
          platform: ios
          target: ipa
          build_args:
            flavor: dev
            export-options-plist: ios/dev_ExportOptions.plist
            dart-define:
              APP_ENV: dev
        publish_to: pgyer

Full Example Configuration

variables:
  PGYER_API_KEY: "your api key"
output: dist/
releases:
  - name: dev
    jobs:
      # Build and publish your apk pkg to pgyer
      - name: release-dev-android
        package:
          platform: android
          target: apk
          build_args:
            flavor: dev
            target-platform: android-arm,android-arm64
            dart-define:
              APP_ENV: dev
        publish_to: pgyer
      # Build and publish your ipa pkg to pgyer
      - name: release-dev-ios
        package:
          platform: ios
          target: ipa
          build_args:
            flavor: dev
            export-options-plist: ios/dev_ExportOptions.plist
            dart-define:
              APP_ENV: dev
        publish_to: pgyer

Release Your App

flutter_distributor release --name dev

Thank You

🎉 🎉 🎉