Codemagic

Setup

Generate an API key — AppFlight mobile app → Settings → API Keys → + — label it Codemagic
Add environment variable — Codemagic → Teams → Environment variables → add APPFLIGHT_API_KEY as a secret
Commit appflight.json to your repository (run appflight init locally first)

codemagic.yaml

workflows:
  android-release:
    name: Android Release
    instance_type: mac_mini_m1
    environment:
      flutter: stable             # or pin: 3.38.2
      java: 17
      groups:
        - appflight               # group containing APPFLIGHT_API_KEY

    scripts:
      - name: Install AppFlight CLI
        script: |
          dart pub global activate appflight_cli
          echo 'export PATH="$PATH:$HOME/.pub-cache/bin"' >> $CM_ENV

      - name: Flutter pub get
        script: flutter pub get

      - name: Build APK
        script: flutter build apk --flavor stage --release

      - name: Upload to AppFlight
        script: appflight upload --flavor stage --ci

    artifacts:
      - build/app/outputs/flutter-apk/*.apk

:::tip Pin your Flutter version Set flutter: 3.38.2 (or whatever your team uses) instead of flutter: stable to avoid silent breakages when Codemagic rolls to a newer stable. :::

workflows:
  android-release:
    name: Android Release
    instance_type: mac_mini_m1
    environment:
      node: 20
      java: 17
      groups:
        - appflight               # group containing APPFLIGHT_API_KEY

    scripts:
      - name: Install AppFlight CLI
        script: |
          dart pub global activate appflight_cli
          echo 'export PATH="$PATH:$HOME/.pub-cache/bin"' >> $CM_ENV

      - name: Install dependencies
        script: npm install

      - name: Build APK
        script: cd android && ./gradlew assembleStageRelease

      - name: Upload to AppFlight
        script: appflight upload --flavor stage --ci

    artifacts:
      - android/app/build/outputs/apk/**/*.apk

:::tip Using Yarn? Replace npm install with yarn install in the dependencies step. :::

:::warning PATH for the installed binary dart pub global activate appflight_cli installs the appflight binary into $HOME/.pub-cache/bin. Codemagic does not put that directory on PATH by default, so the next step fails with appflight: command not found unless you export it yourself. Writing to $CM_ENV persists the PATH change across subsequent script steps. :::

Multi-flavor

Install the CLI once, then repeat build and upload per flavor:

    scripts:
      - name: Install AppFlight CLI
        script: |
          dart pub global activate appflight_cli
          echo 'export PATH="$PATH:$HOME/.pub-cache/bin"' >> $CM_ENV

      - name: Build and upload stage
        script: |
          flutter build apk --flavor stage --release
          appflight upload --flavor stage --ci

      - name: Build and upload qa
        script: |
          flutter build apk --flavor qa --release
          appflight upload --flavor qa --ci

    scripts:
      - name: Install AppFlight CLI
        script: |
          dart pub global activate appflight_cli
          echo 'export PATH="$PATH:$HOME/.pub-cache/bin"' >> $CM_ENV

      - name: Build and upload stage
        script: |
          cd android && ./gradlew assembleStageRelease
          appflight upload --flavor stage --ci

      - name: Build and upload qa
        script: |
          cd android && ./gradlew assembleQaRelease
          appflight upload --flavor qa --ci

Smaller, faster APKs for testing (Flutter)

For tester-only distribution, an arm64-only APK is ~40% smaller and builds faster:

      - name: Build APK
        script: flutter build apk --flavor stage --release --target-platform android-arm64

Skip this for production Play Store builds.

Exit codes

If appflight upload exits non-zero the Codemagic step fails. Common codes:

Code	Meaning	Fix
4	APK not found	Check `apkPath` in `appflight.json` matches your build output
5	Version already uploaded	Bump version in `pubspec.yaml` (Flutter) or `android/app/build.gradle` (React Native)
6	API key invalid or revoked	Regenerate key in AppFlight mobile → Settings → API Keys
8	APK limit reached (plan limit)	Upgrade to First Class in the mobile app

Getting Started

Commands

Configuration

CI / CD

Plans