subosito/flutter-action

Set the Flutter version automatically by pointing to a configuration file like pubspec.yaml, .fvmrc, or .fvm/fvm_config.json using the flutter-version-file input.

Requirement: For pubspec.yaml, the version must be an exact match in the environment.flutter field (e.g., 3.19.0), not a range (e.g., ">= 3.19.0 <4.0.0").

Note: This feature requires yq, which the action installs automatically if needed.

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    with:
      channel: stable
      flutter-version-file: pubspec.yaml
  - run: flutter --version

You can use alternative Flutter repositories (forks) by providing the git-source input.

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    with:
      channel: master
      flutter-version: 3.24.0
      git-source: https://github.com/join-the-flock/flock.git
  - run: flutter --version

To target a specific version regardless of the channel, set channel: any and provide the flutter-version (e.g., 3.x).

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    with:
      channel: any
      flutter-version: 3.x
  - run: flutter --version

To use the latest available release for a specific channel, omit the flutter-version input.

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    with:
      channel: stable # or: beta, master (or: main)
  - run: flutter --version

When using the master channel, you can specify a particular git tag, commit hash, or branch name as the flutter-version.

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    with:
      channel: master
      flutter-version: 5b12b74
  - run: flutter --version

You can configure the Flutter environment by specifying a specific version and a release channel (e.g., stable, beta, master, or main).

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    with:
      channel: stable
      flutter-version: 3.19.0
  - run: flutter --version

You can use wildcard patterns (e.g., 1.22.x) to target the latest release within a specific version range on a given channel.

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    with:
      channel: dev
      flutter-version: 1.22.x
  - run: flutter --version

To use a Flutter mirror (useful for users in certain regions), set the FLUTTER_STORAGE_BASE_URL environment variable in the step.

steps:
  - name: Clone repository
    uses: actions/checkout@v6
  - name: Set up Flutter
    env:
      FLUTTER_STORAGE_BASE_URL: https://storage.flutter-io.cn
    uses: subosito/flutter-action@v2
    with:
      channel: master
      flutter-version: 5b12b74
  - run: flutter --version

To apply a custom patch to the Flutter SDK, use the ${{ env.FLUTTER_ROOT }} environment variable to locate the SDK directory and apply the patch using git apply.

steps:
- name: Clone repository
  uses: actions/checkout@v6
- uses: subosito/flutter-action@v2
  with:
    flutter-version: 3.22.2
    channel: stable
- run: |
    flutter --version
    cd ${{ env.FLUTTER_ROOT }}
    curl https://patch-diff.githubusercontent.com/raw/flutter/flutter/pull/137874.patch | git apply
    git status

You can use the PUB-CACHE-HIT output to conditionally skip expensive steps like melos bootstrap if the dependencies are already cached.

steps:
  - name: Checkout repository
    uses: actions/checkout@v6

  - name: Set up Flutter
    uses: subosito/flutter-action@v2
    id: flutter-action
    with:
      channel: stable
      cache: true

  - name: Conditionally run melos bootstrap
    if: steps.flutter-action.outputs.PUB-CACHE-HIT != 'true'
    run: melos bootstrap

  - name: Continue with build
    run: flutter build apk

The action provides several outputs that can be accessed in subsequent steps. You can also use dry-run: true to retrieve these outputs without installing the Flutter SDK.

# Available outputs:
CACHE-PATH
CACHE-KEY
CHANNEL
VERSION
ARCHITECTURE
PUB-CACHE-PATH
PUB-CACHE-KEY
CACHE-HIT
PUB-CACHE-HIT