Support dynamic values for PUB-CACHE-PATH (#363)

* use expand_key for PUB_CACHE_PATH

* add tests

* add dash

* use PUB_CACHE

.github/workflows/workflow.yaml

@@ -0,0 +1,286 @@
+name: test
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    paths:
+      - setup.sh
+      - action.yaml
+      - .github/workflows/workflow.yaml
+jobs:
+  lint_shellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+      - name: Run shellcheck
+        uses: ludeeus/action-shellcheck@master
+
+  test_channel:
+    runs-on: ${{ matrix.operating-system }}
+
+    strategy:
+      matrix:
+        operating-system:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+          - macos-13
+        channel: [stable, beta, master]
+        dry-run: [true, false]
+        git-source:
+          - https://github.com/flutter/flutter.git
+          - https://github.com/Flutter-Foundation/flutter.git
+          - https://gitee.com/harmonycommando_flutter/flutter.git
+        include:
+          - operating-system: ubuntu-latest
+            channel: main
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+      - id: flutter-action
+        uses: ./
+        with:
+          channel: ${{ matrix.channel }}
+          dry-run: ${{ matrix.dry-run }}
+          git-source: ${{ matrix.git-source }}
+      - name: Echo outputs
+        run: |
+          echo RUNNER-OS=${{ runner.os }}
+          echo RUNNER-ARCH=${{ runner.arch }}
+
+          echo CACHE-PATH=${{ steps.flutter-action.outputs.CACHE-PATH }}
+          echo CACHE-KEY=${{ steps.flutter-action.outputs.CACHE-KEY }}
+          echo CHANNEL=${{ steps.flutter-action.outputs.CHANNEL }}
+          echo VERSION=${{ steps.flutter-action.outputs.VERSION }}
+          echo ARCHITECTURE=${{ steps.flutter-action.outputs.ARCHITECTURE }}
+        shell: bash
+      - run: dart --version
+        if: ${{ matrix.dry-run != true }}
+        shell: bash
+      - run: flutter --version
+        if: ${{ matrix.dry-run != true }}
+        shell: bash
+      - run: "! dart --version"
+        if: ${{ matrix.dry-run == true }}
+        shell: bash
+      - run: "! flutter --version"
+        if: ${{ matrix.dry-run == true }}
+        shell: bash
+
+  test_cache:
+    runs-on: ${{ matrix.operating-system }}
+
+    strategy:
+      matrix:
+        operating-system:
+          [ubuntu-latest, windows-latest, macos-latest, macos-13]
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+      - uses: ./
+        with:
+          channel: stable
+          flutter-version: 3.10.6
+          cache: true
+      - run: dart --version
+        shell: bash
+      - run: flutter --version
+        shell: bash
+
+  test_version_file:
+    runs-on: ${{ matrix.operating-system }}
+
+    strategy:
+      matrix:
+        operating-system: [ubuntu-latest]
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+      - uses: ./
+        with:
+          channel: stable
+          flutter-version-file: test/pubspec.yaml
+      - name: Verify Dart version
+        run: dart --version | grep '2.18.6'
+        shell: bash
+      - name: Verify Flutter version
+        run: flutter --version | grep '3.3.10'
+        shell: bash
+
+  test_print_output_x64:
+    runs-on: ubuntu-latest
+
+    # These calls to setup.sh sepcify the -t flag, which enables test mode.
+    # Test mode uses hardcoded Flutter release manifests from test/ directory.
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+      - run: ./setup.sh -t -p -f test/pubspec.yaml   | grep '3.3.10'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep 'stable'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep '3.7.7'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep 'x64'
+        shell: bash
+      - run: ./setup.sh -t -p stable                 | grep 'stable'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep 'beta'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep '3.9.0-0.1.pre'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3.3.10 stable       | grep '3.3.10'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3.3.1 stable        | grep '3.3.1'
+        shell: bash
+      - run: ./setup.sh -t -p -n 2 stable            | grep '2.10.5'
+        shell: bash
+      - run: ./setup.sh -t -p -n 2 beta              | grep '2.13.0-0.4.pre'
+        shell: bash
+      - run: ./setup.sh -t -p -n 2 any               | grep 'beta'
+        shell: bash
+      - run: ./setup.sh -t -p -n 2 any               | grep '2.13.0-0.4.pre'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3 any               | grep 'beta'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3 any               | grep '3.9.0-0.1.pre'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3 any               | grep 'x64'
+        shell: bash
+      - run: ./setup.sh -t -p -n any stable          | grep 'stable'
+        shell: bash
+      - run: ./setup.sh -t -p -n any stable          | grep '3.7.7'
+        shell: bash
+      - run: ./setup.sh -t -p -n any stable          | grep 'x64'
+        shell: bash
+      - run: ./setup.sh -t -p -n 1 stable            | grep '1.22.6'
+        shell: bash
+      - run: ./setup.sh -t -p -n 0 any               | grep 'beta'
+        shell: bash
+      - run: ./setup.sh -t -p -n 0 any               | grep '0.11.13'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep 'flutter-linux-stable-3.7.7-x64-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p stable                 | grep 'flutter-linux-stable-3.7.7-x64-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep 'flutter-linux-beta-3.9.0-0.1.pre-x64-f732038a8cf4562ce38a1d7debb30209ae3da896'
+        shell: bash
+      - run: ./setup.sh -t -p dev                    | grep 'flutter-linux-dev-2.13.0-0.1.pre-x64-13a2fb10b838971ce211230f8ffdd094c14af02c'
+        shell: bash
+      - run: ./setup.sh -t -p master                 | grep 'flutter-linux-master-any-x64-master'
+        shell: bash
+      - run: ./setup.sh -t -p -n 5b12b74 master      | grep 'flutter-linux-master-5b12b74-x64-master'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3.12.0-12.0.pre master     | grep 'flutter-linux-master-3.12.0-12.0.pre-x64-master'
+        shell: bash
+      - run: ./setup.sh -t -p -n stable master       | grep 'flutter-linux-master-stable-x64-master'
+        shell: bash
+      - run: ./setup.sh -t -p -n 2 any               | grep 'flutter-linux-beta-2.13.0-0.4.pre-x64-25caf1461b8f643092a9f6f5b224453b5c057d10'
+        shell: bash
+      - run: ./setup.sh -t -p -n 1 any               | grep 'flutter-linux-beta-1.26.0-17.8.pre-x64-044f2cf5607a26f8818dab0f766400e85c52bdff'
+        shell: bash
+      - run: ./setup.sh -t -p -n 0 any               | grep 'flutter-linux-beta-0.11.13-x64-58c8489fcdb4e4ef6c010117584c9b23d15221aa'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep '/opt/hostedtoolcache/flutter/stable-3.7.7-x64'
+        shell: bash
+      - run: ./setup.sh -t -p stable                 | grep '/opt/hostedtoolcache/flutter/stable-3.7.7-x64'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep '/opt/hostedtoolcache/flutter/beta-3.9.0-0.1.pre-x64'
+        shell: bash
+      - run: ./setup.sh -t -p dev                    | grep '/opt/hostedtoolcache/flutter/dev-2.13.0-0.1.pre-x64'
+        shell: bash
+      - run: ./setup.sh -t -p master                 | grep '/opt/hostedtoolcache/flutter/master-any-x64'
+        shell: bash
+      - run: ./setup.sh -t -p -k 'custom-:channel:-:version:-:hash:'       | grep 'custom-stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p -k 'custom-:channel:-:version:-:sha256:'     | grep 'custom-stable-3.7.7-cdd49597e88c35e5de5184e9acff433dfbb3c075b74ef7b27790af7f57ce2420'
+        shell: bash
+      - run: ./setup.sh -t -p -c '/tmp/flutter/:channel:-:version:-:hash:' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p -d '/tmp/flutter/:channel:-:version:-:hash:-pub-cache-path' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da-pub-cache-path'
+        shell: bash
+      - run: ./setup.sh -t -p -l '/tmp/flutter/:channel:-:version:-:hash:-pub-cache-key' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da-pub-cache-key'
+        shell: bash
+
+
+  test_print_output_arm64:
+    runs-on: macos-latest
+
+    # These calls to setup.sh sepcify the -t flag, which enables test mode.
+    # Test mode uses hardcoded Flutter release manifests from test/ directory.
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+      - run: ./setup.sh -t -p -f test/pubspec.yaml   | grep '3.3.10'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep 'stable'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep '3.7.7'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep 'arm64'
+        shell: bash
+      - run: ./setup.sh -t -p stable                 | grep 'stable'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep 'beta'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep '3.9.0-0.1.pre'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3.3.10 stable       | grep '3.3.10'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3.3.1 stable        | grep '3.3.1'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3 any               | grep 'beta'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3 any               | grep '3.9.0-0.1.pre'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3 -a arm64 any      | grep 'arm64'
+        shell: bash
+      - run: ./setup.sh -t -p -n any -a arm64 stable | grep 'stable'
+        shell: bash
+      - run: ./setup.sh -t -p -n any -a arm64 stable | grep '3.7.7'
+        shell: bash
+      - run: ./setup.sh -t -p -n any -a arm64 stable | grep 'arm64'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep 'flutter-macos-stable-3.7.7-arm64-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p stable                 | grep 'flutter-macos-stable-3.7.7-arm64-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep 'flutter-macos-beta-3.9.0-0.1.pre-arm64-8b9b90e75107181aadc303d8d7422205863a35dd'
+        shell: bash
+      - run: ./setup.sh -t -p master                 | grep 'flutter-macos-master-any-arm64-master'
+        shell: bash
+      - run: ./setup.sh -t -p -n 5b12b74 master      | grep 'flutter-macos-master-5b12b74-arm64-master'
+        shell: bash
+      - run: ./setup.sh -t -p -n 3.12.0-12.0.pre master     | grep 'flutter-macos-master-3.12.0-12.0.pre-arm64-master'
+        shell: bash
+      - run: ./setup.sh -t -p -n stable master       | grep 'flutter-macos-master-stable-arm64-master'
+        shell: bash
+      - run: ./setup.sh -t -p                        | grep '/Users/runner/hostedtoolcache/flutter/stable-3.7.7-arm64'
+        shell: bash
+      - run: ./setup.sh -t -p stable                 | grep '/Users/runner/hostedtoolcache/flutter/stable-3.7.7-arm64'
+        shell: bash
+      - run: ./setup.sh -t -p beta                   | grep '/Users/runner/hostedtoolcache/flutter/beta-3.9.0-0.1.pre-arm64'
+        shell: bash
+      - run: ./setup.sh -t -p master                 | grep '/Users/runner/hostedtoolcache/flutter/master-any-arm64'
+        shell: bash
+      - run: ./setup.sh -t -p -k 'custom-:channel:-:version:-:hash:'       | grep 'custom-stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p -k 'custom-:channel:-:version:-:sha256:'     | grep 'custom-stable-3.7.7-0511b9f164a62f467b063e6c83d9c683bb3fb056ee556b2f45e987a2c2f4a260'
+        shell: bash
+      - run: ./setup.sh -t -p -c '/tmp/flutter/:channel:-:version:-:hash:' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da'
+        shell: bash
+      - run: ./setup.sh -t -p -d '/tmp/flutter/:channel:-:version:-:hash:-pub-cache-path' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da-pub-cache-path'
+        shell: bash
+      - run: ./setup.sh -t -p -l '/tmp/flutter/:channel:-:version:-:hash:-pub-cache-key' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da-pub-cache-key'
+        shell: bash

.github/workflows/workflow.yml

@@ -1,133 +0,0 @@
-name: Main workflow
-on:
-  push:
-    branches:
-      - main
-      - dev
-  pull_request:
-    paths:
-      - setup.sh
-      - action.yml
-jobs:
-  lint_shellcheck:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ludeeus/action-shellcheck@master
-  test_channel:
-    runs-on: ${{ matrix.operating-system }}
-    strategy:
-      matrix:
-        operating-system: [ubuntu-latest, windows-latest, macos-latest]
-        channel: [stable, beta, master]
-    steps:
-    - uses: actions/checkout@v3
-    - id: flutter-action
-      uses: ./
-      with:
-        channel: ${{ matrix.channel }}
-    - name: Echo outputs
-      run: |
-        echo CACHE-PATH=${{ steps.flutter-action.outputs.CACHE-PATH }}
-        echo CACHE-KEY=${{ steps.flutter-action.outputs.CACHE-KEY }}
-        echo CHANNEL=${{ steps.flutter-action.outputs.CHANNEL }}
-        echo VERSION=${{ steps.flutter-action.outputs.VERSION }}
-        echo ARCHITECTURE=${{ steps.flutter-action.outputs.ARCHITECTURE }}
-      shell: bash
-    - run: dart --version
-      shell: bash
-    - run: flutter --version
-      shell: bash
-  test_cache:
-    runs-on: ${{ matrix.operating-system }}
-    strategy:
-      matrix:
-        operating-system: [ubuntu-latest, windows-latest, macos-latest]
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ./
-      with:
-        channel: stable
-        cache: true
-    - run: dart --version
-      shell: bash
-    - run: flutter --version
-      shell: bash
-  test_print_output:
-    runs-on: macos-latest
-    steps:
-    - uses: actions/checkout@v3
-    - run: ./setup.sh -t -p                        | grep 'stable'
-      shell: bash
-    - run: ./setup.sh -t -p                        | grep '3.7.7'
-      shell: bash
-    - run: ./setup.sh -t -p                        | grep 'x64'
-      shell: bash
-    - run: ./setup.sh -t -p stable                 | grep 'stable'
-      shell: bash
-    - run: ./setup.sh -t -p beta                   | grep 'beta'
-      shell: bash
-    - run: ./setup.sh -t -p beta                   | grep '3.9.0-0.1.pre'
-      shell: bash
-    - run: ./setup.sh -t -p -n 3.3.10 stable       | grep '3.3.10'
-      shell: bash
-    - run: ./setup.sh -t -p -n 3.3.1 stable        | grep '3.3.1'
-      shell: bash
-    - run: ./setup.sh -t -p -n 2 stable            | grep '2.10.5'
-      shell: bash
-    - run: ./setup.sh -t -p -n 2 beta              | grep '2.13.0-0.4.pre'
-      shell: bash
-    - run: ./setup.sh -t -p -n 2 any               | grep 'beta'
-      shell: bash
-    - run: ./setup.sh -t -p -n 2 any               | grep '2.13.0-0.4.pre'
-      shell: bash
-    - run: ./setup.sh -t -p -n 3 any               | grep 'beta'
-      shell: bash
-    - run: ./setup.sh -t -p -n 3 any               | grep '3.9.0-0.1.pre'
-      shell: bash
-    - run: ./setup.sh -t -p -n 3 -a arm64 any      | grep 'arm64'
-      shell: bash
-    - run: ./setup.sh -t -p -n any -a arm64 stable | grep 'stable'
-      shell: bash
-    - run: ./setup.sh -t -p -n any -a arm64 stable | grep '3.7.7'
-      shell: bash
-    - run: ./setup.sh -t -p -n any -a arm64 stable | grep 'arm64'
-      shell: bash
-    - run: ./setup.sh -t -p -n 1 stable            | grep '1.22.6'
-      shell: bash
-    - run: ./setup.sh -t -p -n 0 any               | grep 'beta'
-      shell: bash
-    - run: ./setup.sh -t -p -n 0 any               | grep '0.11.13'
-      shell: bash
-    - run: ./setup.sh -t -p                        | grep 'flutter-macos-stable-3.7.7-x64-2ad6cd72c040113b47ee9055e722606a490ef0da'
-      shell: bash
-    - run: ./setup.sh -t -p stable                 | grep 'flutter-macos-stable-3.7.7-x64-2ad6cd72c040113b47ee9055e722606a490ef0da'
-      shell: bash
-    - run: ./setup.sh -t -p beta                   | grep 'flutter-macos-beta-3.9.0-0.1.pre-x64-f732038a8cf4562ce38a1d7debb30209ae3da896'
-      shell: bash
-    - run: ./setup.sh -t -p dev                    | grep 'flutter-macos-dev-2.11.0-0.1.pre-x64-b101bfe32f634566e7cb2791a9efe19cf8828b15'
-      shell: bash
-    - run: ./setup.sh -t -p master                 | grep 'flutter-macos-master-master-x64-master'
-      shell: bash
-    - run: ./setup.sh -t -p -n 2 any               | grep 'flutter-macos-beta-2.13.0-0.4.pre-x64-25caf1461b8f643092a9f6f5b224453b5c057d10'
-      shell: bash
-    - run: ./setup.sh -t -p -n 1 any               | grep 'flutter-macos-beta-1.26.0-17.8.pre-x64-044f2cf5607a26f8818dab0f766400e85c52bdff'
-      shell: bash
-    - run: ./setup.sh -t -p -n 0 any               | grep 'flutter-macos-beta-0.11.13-x64-58c8489fcdb4e4ef6c010117584c9b23d15221aa'
-      shell: bash
-    - run: ./setup.sh -t -p                        | grep '/Users/runner/work/_temp/flutter/stable-3.7.7-x64'
-      shell: bash
-    - run: ./setup.sh -t -p stable                 | grep '/Users/runner/work/_temp/flutter/stable-3.7.7-x64'
-      shell: bash
-    - run: ./setup.sh -t -p beta                   | grep '/Users/runner/work/_temp/flutter/beta-3.9.0-0.1.pre-x64'
-      shell: bash
-    - run: ./setup.sh -t -p dev                    | grep '/Users/runner/work/_temp/flutter/dev-2.11.0-0.1.pre-x64'
-      shell: bash
-    - run: ./setup.sh -t -p master                 | grep '/Users/runner/work/_temp/flutter/master-master-x64'
-      shell: bash
-    - run: ./setup.sh -t -p -k 'custom-:channel:-:version:-:hash:'       | grep 'custom-stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da'
-      shell: bash
-    - run: ./setup.sh -t -p -k 'custom-:channel:-:version:-:sha256:'     | grep 'custom-stable-3.7.7-78957b52f023a0d811add27eddc59b1a59d27d2ada5df123f39d0315708fb2d5'
-      shell: bash
-    - run: ./setup.sh -t -p -c '/tmp/flutter/:channel:-:version:-:hash:' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da'
-      shell: bash

README.md

@@ -1,169 +1,332 @@
 # flutter-action
 
-Flutter environment for use in GitHub Actions. It works on Linux, Windows, and macOS.
+Flutter environment for use in GitHub Actions. It works on Linux, Windows, and
+macOS.
 
-## Usage
+Originally created by [Alif Rachmawadi]. Maintained by [Bartek Pacia].
 
-Use specific version and channel:
+The following sections show how to configure this action.
+
+## Specifying Flutter version
+
+### Use specific version and channel
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- uses: subosito/flutter-action@v2
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
     with:
-    flutter-version: '3.7.7'
+      channel: stable
-    channel: 'stable'
+      flutter-version: 3.19.0
   - run: flutter --version
 ```
 
-Use latest release for particular channel:
+### Use version from pubspec.yaml
+
+This is inspired by [`actions/setup-go`](https://github.com/actions/setup-go).
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- uses: subosito/flutter-action@v2
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
     with:
-    channel: 'stable' # or: 'beta', 'dev' or 'master'
+      channel: stable
+      flutter-version-file: pubspec.yaml # path to pubspec.yaml
   - run: flutter --version
 ```
 
-Use latest release for particular version and/or channel:
+> [!IMPORTANT]
+>
+> For `flutter-version-file` to work, you need to have the exact Flutter version
+> defined in your pubspec.yaml:
+>
+> **Good**
+>
+> ```yaml
+> environment:
+>   sdk: ">=3.3.0 <4.0.0"
+>   flutter: 3.19.0
+> ```
+>
+> **Bad**
+>
+> ```yaml
+> environment:
+>   sdk: ">=3.3.0 <4.0.0"
+>   flutter: ">= 3.19.0 <4.0.0"
+> ```
+
+> [!NOTE]
+>
+> Using `flutter-version-file` requires [`yq`](https://github.com/mikefarah/yq),
+> which is not pre-installed in `windows` runners. Fortunately, since version
+> 2.18.0, this action installs `yq` automatically if `flutter-version-file`
+> is specified, so no action is required from you.
+
+### Use latest release for particular channel
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- uses: subosito/flutter-action@v2
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
     with:
-    flutter-version: '1.22.x'
+      channel: stable # or: beta, master (or main)
-    channel: 'dev'
   - run: flutter --version
 ```
 
-Use particular version on any channel:
+### Use latest release for particular version and/or channel
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- uses: subosito/flutter-action@v2
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
     with:
-    flutter-version: '2.x'
+      channel: dev
-    channel: 'any'
+      flutter-version: 1.22.x
   - run: flutter --version
 ```
 
-Build Android APK and app bundle:
+### Use particular version on any channel
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- uses: actions/setup-java@v2
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
     with:
-    distribution: 'zulu'
+      channel: any
-    java-version: '11'
+      flutter-version: 3.x
+  - run: flutter --version
+```
+
+### Use particular git reference on master channel
+
+```yaml
+steps:
+  - name: Clone repository
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
+    with:
+      channel: master
+      flutter-version: 5b12b74 # tag, commit or branch
+  - run: flutter --version
+```
+
+### Use a Flutter mirror by set ENV
+
+You can get more infomation from [Flutter official docs](https://docs.flutter.dev/community/china).
+
+```yaml
+steps:
+  - name: Clone repository
+    uses: actions/checkout@v4
+  - 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 # tag, commit or branch
+  - run: flutter --version
+```
+
+### Use alternative Flutter repository
+
+This action supports "alternative Flutters" in addition to the official
+[`flutter/flutter`](https://github.com/flutter/flutter), for example:
+- [Flock](https://github.com/join-the-flock/flock.git)
+- [a Flutter fork that supports
+  HarmonyOS](https://gitee.com/harmonycommando_flutter/flutter.git)
+
+```yaml
+steps:
+  - name: Clone repository
+    uses: actions/checkout@v4
+  - 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
+```
+
+> [!NOTE]
+>
+> This feature was implemented in
+> [#344](https://github.com/subosito/flutter-action/pull/334) and is available
+> since v2.18.0.
+
+### Apply a patch
+
+Sometimes you find a bug in Flutter and you fix it yourself (you're a
+rockstar!), and then submit a patch/PR to Flutter repository. However, everyone
+knows that code review takes time, but your app needs the fix _now_.
+
+You can apply your patch like this:
+
+```yaml
+steps:
+- name: Clone repository
+  uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
   with:
-    flutter-version: '3.7.7'
+    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
+```
+
+> [!NOTE]
+>
+> This was first discussed in [this issue](https://github.com/subosito/flutter-action/issues/310).
+
+## Build targets
+
+Build **Android** APK and app bundle:
+
+```yaml
+steps:
+  - name: Clone repository
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
+    with:
+      flutter-version: 3.24.0
   - run: flutter pub get
   - run: flutter test
   - run: flutter build apk
   - run: flutter build appbundle
 ```
 
-Build for iOS (macOS only):
+### Build for iOS
+
+> [!NOTE]
+>
+> Building for iOS requires a macOS runner.
 
 ```yaml
 jobs:
-  build:
+  main:
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v3
+      - name: Clone repository
-    - uses: subosito/flutter-action@v2
+        uses: actions/checkout@v4
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
         with:
-        channel: 'stable'
+          channel: stable
-        architecture: x64
       - run: flutter pub get
       - run: flutter test
       - run: flutter build ios --release --no-codesign
 ```
 
-Build for the web:
+### Build for the web
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- uses: subosito/flutter-action@v2
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
     with:
-    channel: 'stable'
+      channel: stable
   - run: flutter pub get
   - run: flutter test
   - run: flutter build web
 ```
 
-Build for Windows:
+### Build for Windows
 
 ```yaml
 jobs:
- build:
+  main:
     runs-on: windows-latest
     steps:
-     - uses: actions/checkout@v3
+      - name: Clone repository
-     - uses: subosito/flutter-action@v2
+        uses: actions/checkout@v4
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
         with:
-         channel: 'beta'
+          channel: stable
-     - run: flutter config --enable-windows-desktop
       - run: flutter build windows
 ```
 
-Build for Linux desktop:
+### Build for Linux desktop
 
 ```yaml
 jobs:
- build:
+  main:
     runs-on: ubuntu-latest
     steps:
-     - uses: actions/checkout@v3
+      - name: Clone repository
-     - uses: subosito/flutter-action@v2
+        uses: actions/checkout@v4
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
         with:
-         channel: 'stable'
+          channel: stable
       - run: |
           sudo apt-get update -y
           sudo apt-get install -y ninja-build libgtk-3-dev
-     - run: flutter config --enable-linux-desktop
       - run: flutter build linux
 ```
 
-Build for macOS desktop:
+### Build for macOS desktop
+
+> [!NOTE]
+>
+> Building for macOS requires a macOS runner.
 
 ```yaml
 jobs:
- build:
+  main:
     runs-on: macos-latest
     steps:
-     - uses: actions/checkout@v3
+      - name: Clone repository
-     - uses: subosito/flutter-action@v2
+        uses: actions/checkout@v4
+      - name: Set up Flutter
+        uses: subosito/flutter-action@v2
         with:
-         channel: 'stable'
+          channel: stable
-         architecture: x64
-     - run: flutter config --enable-macos-desktop
       - run: flutter build macos
 ```
 
-Integration with `actions/cache`:
+## Caching
+
+Integration with [`actions/cache`](https://github.com/actions/cache):
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- uses: subosito/flutter-action@v2
+    uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
     with:
-    channel: 'stable'
+      channel: stable
       cache: true
-    cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:' # optional, change this to force refresh cache
+      # optional parameters follow
-    cache-path: ${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch: # optional, change this to specify the cache path
+      cache-key: "flutter-:os:-:channel:-:version:-:arch:-:hash:" # optional, change this to force refresh cache
-    architecture: x64 # optional, x64 or arm64
+      cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:" # optional, change this to specify the cache path
+      pub-cache-key: "flutter-pub-:os:-:channel:-:version:-:arch:-:hash:" # optional, change this to force refresh cache of dart pub get dependencies
+      pub-cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:" # optional, change this to specify the cache path
   - run: flutter --version
 ```
 
-Note: `cache-key` and `cache-path` has support for several dynamic values:
+Note: `cache-key`, `pub-cache-key`, and `cache-path` have support for several
+dynamic values:
 
 - `:os:`
 - `:channel:`
@@ -172,20 +335,88 @@ Note: `cache-key` and `cache-path` has support for several dynamic values:
 - `:hash:`
 - `:sha256:`
 
+### Using cache outputs
+
+> [!NOTE]
+> `PUB-CACHE-HIT` and `CACHE-HIT` directly use the `cache-hit` output from `actions/cache@v4`, which is the following:
+> - `cache-hit` - A string value to indicate an exact match was found for the key.
+>   - If there's a cache hit, this will be 'true' or 'false' to indicate if there's an exact match for `key`.
+>   - If there's a cache miss, this will be an empty string.
+
+Example usage (inspired by [actions/cache@v4](https://github.com/actions/cache/blob/c45d39173a637a28edbd526cb160189cc4e84f5a/README.md#skipping-steps-based-on-cache-hit) and [#346](https://github.com/subosito/flutter-action/pull/346)) to skip `melos bootstrap` if there was a pub cache hit:
+
+```
+steps:
+  - name: Checkout repository
+    uses: actions/checkout@v4
+
+  - 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
+```
+
+## Outputs
+
 Use outputs from `flutter-action`:
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+  - name: Clone repository
-- id: flutter-action
+  - uses: actions/checkout@v4
+  - name: Set up Flutter
     uses: subosito/flutter-action@v2
+    id: flutter-action
     with:
-    channel: 'stable'
+      channel: stable
+  - name: Print outputs
+    shell: bash
+    run: |
+      echo CACHE-PATH=${{ steps.flutter-action.outputs.CACHE-PATH }}
+      echo CACHE-KEY=${{ steps.flutter-action.outputs.CACHE-KEY }}
+      echo CHANNEL=${{ steps.flutter-action.outputs.CHANNEL }}
+      echo VERSION=${{ steps.flutter-action.outputs.VERSION }}
+      echo ARCHITECTURE=${{ steps.flutter-action.outputs.ARCHITECTURE }}
+      echo PUB-CACHE-PATH=${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}
+      echo PUB-CACHE-KEY=${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}
+      echo CACHE-HIT=${{ steps.flutter-action.outputs.CACHE-HIT }}
+      echo PUB-CACHE-HIT=${{ steps.flutter-action.outputs.PUB-CACHE-HIT }}
+```
+
+If you don't need to install Flutter and just want the outputs, you can use the
+`dry-run` option:
+
+```yaml
+steps:
+  - name: Clone repository
+  - uses: actions/checkout@v4
+  - name: Set up Flutter
+    uses: subosito/flutter-action@v2
+    id: flutter-action
+    with:
+      channel: stable
+      dry-run: true
   - run: |
       echo CACHE-PATH=${{ steps.flutter-action.outputs.CACHE-PATH }}
       echo CACHE-KEY=${{ steps.flutter-action.outputs.CACHE-KEY }}
       echo CHANNEL=${{ steps.flutter-action.outputs.CHANNEL }}
       echo VERSION=${{ steps.flutter-action.outputs.VERSION }}
       echo ARCHITECTURE=${{ steps.flutter-action.outputs.ARCHITECTURE }}
+      echo PUB-CACHE-PATH=${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}
+      echo PUB-CACHE-KEY=${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}
+      echo CACHE-HIT=${{ steps.flutter-action.outputs.CACHE-HIT }}
+      echo PUB-CACHE-HIT=${{ steps.flutter-action.outputs.PUB-CACHE-HIT }}
     shell: bash
 ```
+
+[Alif Rachmawadi]: https://github.com/subosito
+[Bartek Pacia]: https://github.com/bartekpacia

action.yaml

@@ -0,0 +1,142 @@
+name: Set up Flutter
+description: Setup your runner with Flutter environment
+author: Alif Rachmawadi
+branding:
+  icon: maximize
+  color: blue
+
+inputs:
+  channel:
+    description: The Flutter build release channel
+    required: false
+    default: stable
+  flutter-version:
+    description: The Flutter version to make available on the path
+    required: false
+    default: ""
+  flutter-version-file:
+    description: The pubspec.yaml file with exact Flutter version defined
+    required: false
+    default: ""
+  architecture:
+    description: The architecture of Flutter SDK executable (x64 or arm64)
+    required: false
+    default: "${{ runner.arch }}"
+  cache:
+    description: Cache the Flutter SDK
+    required: false
+    default: "false"
+  cache-key:
+    description: Identifier for the Flutter SDK cache
+    required: false
+    default: ""
+  cache-path:
+    description: Flutter SDK cache path
+    required: false
+    default: ""
+  pub-cache-key:
+    description: Identifier for the Dart .pub-cache cache
+    required: false
+    default: ""
+  pub-cache-path:
+    description: Flutter pub cache path
+    required: false
+    default: default
+  dry-run:
+    description: If true, get outputs but do not install Flutter
+    required: false
+    default: "false"
+  git-source:
+    description: Git clone source
+    required: false
+    default: "https://github.com/flutter/flutter.git"
+
+outputs:
+  CHANNEL:
+    value: "${{ steps.flutter-action.outputs.CHANNEL }}"
+    description: The selected Flutter release channel
+  VERSION:
+    value: "${{ steps.flutter-action.outputs.VERSION }}"
+    description: The selected Flutter version
+  ARCHITECTURE:
+    value: "${{ steps.flutter-action.outputs.ARCHITECTURE }}"
+    description: The selected Flutter CPU architecture
+  CACHE-KEY:
+    value: "${{ steps.flutter-action.outputs.CACHE-KEY }}"
+    description: Key used to cache the Flutter SDK
+  CACHE-PATH:
+    value: "${{ steps.flutter-action.outputs.CACHE-PATH }}"
+    description: Path to Flutter SDK
+  PUB-CACHE-KEY:
+    value: "${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}"
+    description: Key used to cache the pub dependencies
+  PUB-CACHE-PATH:
+    value: "${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}"
+    description: Path to pub cache
+  GIT_SOURCE:
+    value: "${{ steps.flutter-action.outputs.GIT_SOURCE }}"
+    description: Git source of Flutter SDK repository to clone
+  CACHE-HIT:
+    value: "${{ steps.cache-flutter.outputs.cache-hit }}"
+    description: "`true` if the flutter cache was a hit"
+  PUB-CACHE-HIT:
+    value: "${{ steps.cache-pub.outputs.cache-hit }}"
+    description: "`true` if the pub cache was a hit"
+
+runs:
+  using: composite
+  steps:
+    # This is a cross-platform composite action that needs yq in order to parse
+    # the pubspec.yaml file.
+    # It's not preinstalled on Windows runners.
+    # See https://github.com/actions/runner-images/issues/7443#issuecomment-1514597691
+    - name: Make yq tool available on Windows runners
+      if: runner.os == 'Windows' && inputs.flutter-version-file != ''
+      run: choco install yq
+      shell: bash
+
+    - name: Make setup script executable
+      run: chmod +x "$GITHUB_ACTION_PATH/setup.sh"
+      shell: bash
+
+    - name: Set action inputs
+      id: flutter-action
+      shell: bash
+      run: |
+        $GITHUB_ACTION_PATH/setup.sh -p \
+          -n '${{ inputs.flutter-version }}' \
+          -f '${{ inputs.flutter-version-file }}' \
+          -a '${{ inputs.architecture }}' \
+          -k '${{ inputs.cache-key }}' \
+          -c '${{ inputs.cache-path }}' \
+          -l '${{ inputs.pub-cache-key }}' \
+          -d '${{ inputs.pub-cache-path }}' \
+          -g '${{ inputs.git-source }}' \
+          ${{ inputs.channel }}
+
+    - name: Cache Flutter
+      id: cache-flutter
+      uses: actions/cache@v4
+      if: ${{ inputs.cache == 'true' }}
+      with:
+        path: ${{ steps.flutter-action.outputs.CACHE-PATH }}
+        key: ${{ steps.flutter-action.outputs.CACHE-KEY }}
+
+    - name: Cache pub dependencies
+      uses: actions/cache@v4
+      id: cache-pub
+      if: ${{ inputs.cache == 'true' }}
+      with:
+        path: ${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}
+        key: ${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
+
+    - name: Run setup script
+      shell: bash
+      if: ${{ inputs.dry-run != 'true' && inputs.dry-run != true }}
+      run: |
+        $GITHUB_ACTION_PATH/setup.sh \
+          -n '${{ steps.flutter-action.outputs.VERSION }}' \
+          -a '${{ steps.flutter-action.outputs.ARCHITECTURE }}' \
+          -c '${{ steps.flutter-action.outputs.CACHE-PATH }}' \
+          -d '${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}' \
+          ${{ steps.flutter-action.outputs.CHANNEL }}

action.yml

@@ -1,58 +0,0 @@
-name: 'Flutter action'
-description: 'Setup your runner with Flutter environment'
-author: 'Alif Rachmawadi'
-branding:
-  icon: 'maximize'
-  color: 'blue'
-inputs:
-  flutter-version:
-    description: 'The Flutter version to make available on the path'
-    required: false
-    default: 'any'
-  channel:
-    description: 'The Flutter build release channel'
-    required: false
-    default: 'stable'
-  cache:
-    description: 'Cache the Flutter SDK'
-    required: false
-    default: false
-  cache-key:
-    description: 'Identifier for the Flutter SDK cache'
-    required: false
-    default: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
-  cache-path:
-    description: 'Flutter SDK cache path'
-    required: false
-    default: '${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:'
-  architecture:
-    description: 'The architecture of Flutter SDK executable (x64 or arm64)'
-    required: false
-    default: '${{ runner.arch }}'
-outputs:
-  CACHE-PATH:
-    value: '${{ steps.flutter-action.outputs.CACHE-PATH }}'
-  CACHE-KEY:
-    value: '${{ steps.flutter-action.outputs.CACHE-KEY }}'
-  CHANNEL:
-    value: '${{ steps.flutter-action.outputs.CHANNEL }}'
-  VERSION:
-    value: '${{ steps.flutter-action.outputs.VERSION }}'
-  ARCHITECTURE:
-    value: '${{ steps.flutter-action.outputs.ARCHITECTURE }}'
-runs:
-  using: 'composite'
-  steps:
-    - id: flutter-action
-      run: $GITHUB_ACTION_PATH/setup.sh -p -c '${{ inputs.cache-path }}' -k '${{ inputs.cache-key }}' -n '${{ inputs.flutter-version }}' -a '${{ inputs.architecture }}' ${{ inputs.channel }}
-      shell: bash
-    - if: ${{ inputs.cache == 'true' }}
-      uses: actions/cache@v3
-      with:
-        path: ${{ steps.flutter-action.outputs.CACHE-PATH }}
-        key: ${{ steps.flutter-action.outputs.CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
-        restore-keys: |
-          ${{ steps.flutter-action.outputs.CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
-          ${{ steps.flutter-action.outputs.CACHE-KEY }}
-    - run: $GITHUB_ACTION_PATH/setup.sh -c '${{ steps.flutter-action.outputs.CACHE-PATH }}' -n '${{ steps.flutter-action.outputs.VERSION }}' -a '${{ steps.flutter-action.outputs.ARCHITECTURE }}' ${{ steps.flutter-action.outputs.CHANNEL }}
-      shell: bash

setup.sh

@@ -1,16 +1,18 @@
 #!/bin/bash
+set -eu
 
 check_command() {
 	command -v "$1" >/dev/null 2>&1
 }
 
 if ! check_command jq; then
-	echo "jq not found, please install it, https://stedolan.github.io/jq/download/"
+	echo "jq not found. Install it from https://stedolan.github.io/jq"
 	exit 1
 fi
 
 OS_NAME=$(echo "$RUNNER_OS" | awk '{print tolower($0)}')
-MANIFEST_BASE_URL="https://storage.googleapis.com/flutter_infra_release/releases"
+ARCH_NAME=$(echo "$RUNNER_ARCH" | awk '{print tolower($0)}')
+MANIFEST_BASE_URL="${FLUTTER_STORAGE_BASE_URL:-https://storage.googleapis.com}/flutter_infra_release/releases"
 MANIFEST_JSON_PATH="releases_$OS_NAME.json"
 MANIFEST_URL="$MANIFEST_BASE_URL/$MANIFEST_JSON_PATH"
 
@@ -31,7 +33,7 @@ not_found_error() {
 }
 
 transform_path() {
-	if [[ "$OS_NAME" == windows ]]; then
+	if [ "$OS_NAME" = windows ]; then
 		echo "$1" | sed -e 's/^\///' -e 's/\//\\/g'
 	else
 		echo "$1"
@@ -47,65 +49,116 @@ download_archive() {
 
 	mkdir -p "$2"
 
-	if [[ "$archive_name" == *zip ]]; then
+	case "$archive_name" in
-		unzip -q -o "$archive_local" -d "$RUNNER_TEMP"
+	*.zip)
+		EXTRACT_PATH="$RUNNER_TEMP/_unzip_temp"
+		unzip -q -o "$archive_local" -d "$EXTRACT_PATH"
 		# Remove the folder again so that the move command can do a simple rename
 		# instead of moving the content into the target folder.
 		# This is a little bit of a hack since the "mv --no-target-directory"
 		# linux option is not available here
 		rm -r "$2"
-		mv "$RUNNER_TEMP"/flutter "$2"
+		mv "$EXTRACT_PATH"/flutter "$2"
-	else
+		rm -r "$EXTRACT_PATH"
+		;;
+	*)
 		tar xf "$archive_local" -C "$2" --strip-components=1
-	fi
+		;;
+	esac
 
 	rm "$archive_local"
 }
 
 CACHE_PATH=""
 CACHE_KEY=""
+PUB_CACHE_PATH=""
+PUB_CACHE_KEY=""
 PRINT_ONLY=""
 TEST_MODE=false
 ARCH=""
 VERSION=""
+VERSION_FILE=""
+GIT_SOURCE=""
 
-while getopts 'tc:k:pa:n:' flag; do
+while getopts 'tc:k:d:l:pa:n:f:g:' flag; do
 	case "$flag" in
 	c) CACHE_PATH="$OPTARG" ;;
 	k) CACHE_KEY="$OPTARG" ;;
+	d) PUB_CACHE_PATH="$OPTARG" ;;
+	l) PUB_CACHE_KEY="$OPTARG" ;;
 	p) PRINT_ONLY=true ;;
 	t) TEST_MODE=true ;;
 	a) ARCH="$(echo "$OPTARG" | awk '{print tolower($0)}')" ;;
 	n) VERSION="$OPTARG" ;;
+	f)
+		VERSION_FILE="$OPTARG"
+		if [ -n "$VERSION_FILE" ] && ! check_command yq; then
+			echo "yq not found. Install it from https://mikefarah.gitbook.io/yq"
+			exit 1
+		fi
+		;;
+	g) GIT_SOURCE="$OPTARG" ;;
 	?) exit 2 ;;
 	esac
 done
 
+[ -z "$ARCH" ] && ARCH="$ARCH_NAME"
+
+if [ -n "$VERSION_FILE" ]; then
+	if [ -n "$VERSION" ]; then
+		echo "Cannot specify both a version and a version file"
+		exit 1
+	fi
+
+	VERSION="$(yq eval '.environment.flutter' "$VERSION_FILE")"
+fi
+
 ARR_CHANNEL=("${@:$OPTIND:1}")
-CHANNEL="${ARR_CHANNEL[0]}"
+CHANNEL="${ARR_CHANNEL[0]:-}"
 
-[[ -z $CHANNEL ]] && CHANNEL=stable
+[ -z "$CHANNEL" ] && CHANNEL=stable
-[[ -z $VERSION ]] && VERSION=any
+[ -z "$VERSION" ] && VERSION=any
-[[ -z $ARCH ]] && ARCH=x64
+[ -z "$ARCH" ] && ARCH=x64
-[[ -z $CACHE_PATH ]] && CACHE_PATH="$RUNNER_TEMP/flutter/:channel:-:version:-:arch:"
+[ -z "$CACHE_PATH" ] && CACHE_PATH="$RUNNER_TOOL_CACHE/flutter/:channel:-:version:-:arch:"
-[[ -z $CACHE_KEY ]] && CACHE_KEY="flutter-:os:-:channel:-:version:-:arch:-:hash:"
+[ -z "$CACHE_KEY" ] && CACHE_KEY="flutter-:os:-:channel:-:version:-:arch:-:hash:"
+[ -z "$PUB_CACHE_KEY" ] && PUB_CACHE_KEY="flutter-pub-:os:-:channel:-:version:-:arch:-:hash:"
+[ -z "$PUB_CACHE_PATH" ] && PUB_CACHE_PATH="default"
+[ -z "$GIT_SOURCE" ] && GIT_SOURCE="https://github.com/flutter/flutter.git"
 
-if [[ "$TEST_MODE" == true ]]; then
+# `PUB_CACHE` is what Dart and Flutter looks for in the environment, while
+# `PUB_CACHE_PATH` is passed in from the action.
+#
+# If `PUB_CACHE` is set already, then it should continue to be used. Otherwise, satisfy it
+# if the action requests a custom path, or set to the Dart default values depending
+# on the operating system.
+if [ -z "${PUB_CACHE:-}" ]; then
+	if [ "$PUB_CACHE_PATH" != "default" ]; then
+		PUB_CACHE="$PUB_CACHE_PATH"
+	elif [ "$OS_NAME" = "windows" ]; then
+		PUB_CACHE="$LOCALAPPDATA\\Pub\\Cache"
+	else
+		PUB_CACHE="$HOME/.pub-cache"
+	fi
+fi
+
+if [ "$TEST_MODE" = true ]; then
 	RELEASE_MANIFEST=$(cat "$(dirname -- "${BASH_SOURCE[0]}")/test/$MANIFEST_JSON_PATH")
 else
 	RELEASE_MANIFEST=$(curl --silent --connect-timeout 15 --retry 5 "$MANIFEST_URL")
 fi
 
-if [[ "$CHANNEL" == "master" ]]; then
+if [ "$CHANNEL" = "master" ] || [ "$CHANNEL" = "main" ]; then
-	VERSION_MANIFEST="{\"channel\":\"$CHANNEL\",\"version\":\"$CHANNEL\",\"dart_sdk_arch\":\"$ARCH\",\"hash\":\"$CHANNEL\",\"sha256\":\"$CHANNEL\"}"
+	VERSION_MANIFEST="{\"channel\":\"$CHANNEL\",\"version\":\"$VERSION\",\"dart_sdk_arch\":\"$ARCH\",\"hash\":\"$CHANNEL\",\"sha256\":\"$CHANNEL\"}"
 else
 	VERSION_MANIFEST=$(echo "$RELEASE_MANIFEST" | filter_by_channel "$CHANNEL" | filter_by_arch "$ARCH" | filter_by_version "$VERSION")
 fi
 
-if [[ "$VERSION_MANIFEST" == *null* ]]; then
+case "$VERSION_MANIFEST" in
+*null*)
 	not_found_error "$CHANNEL" "$VERSION" "$ARCH"
 	exit 1
-fi
+	;;
+esac
 
 expand_key() {
 	version_channel=$(echo "$VERSION_MANIFEST" | jq -r '.channel')
@@ -125,38 +178,50 @@ expand_key() {
 }
 
 CACHE_KEY=$(expand_key "$CACHE_KEY")
+PUB_CACHE_KEY=$(expand_key "$PUB_CACHE_KEY")
 CACHE_PATH=$(expand_key "$(transform_path "$CACHE_PATH")")
+PUB_CACHE=$(expand_key "$(transform_path "$PUB_CACHE")")
 
-if [[ "$PRINT_ONLY" == true ]]; then
+if [ "$PRINT_ONLY" = true ]; then
 	version_info=$(echo "$VERSION_MANIFEST" | jq -j '.channel,":",.version,":",.dart_sdk_arch // "x64"')
 
 	info_channel=$(echo "$version_info" | awk -F ':' '{print $1}')
 	info_version=$(echo "$version_info" | awk -F ':' '{print $2}')
 	info_architecture=$(echo "$version_info" | awk -F ':' '{print $3}')
 
-	if [[ "$TEST_MODE" == true ]]; then
+	if [ "$TEST_MODE" = true ]; then
 		echo "CHANNEL=$info_channel"
 		echo "VERSION=$info_version"
+		# VERSION_FILE is not printed, because it is essentially same as VERSION
 		echo "ARCHITECTURE=$info_architecture"
 		echo "CACHE-KEY=$CACHE_KEY"
 		echo "CACHE-PATH=$CACHE_PATH"
+		echo "PUB-CACHE-KEY=$PUB_CACHE_KEY"
+		echo "PUB-CACHE-PATH=$PUB_CACHE"
 		exit 0
 	fi
 
 	{
 		echo "CHANNEL=$info_channel"
 		echo "VERSION=$info_version"
+		# VERSION_FILE is not printed, because it is essentially same as VERSION
 		echo "ARCHITECTURE=$info_architecture"
 		echo "CACHE-KEY=$CACHE_KEY"
 		echo "CACHE-PATH=$CACHE_PATH"
-	} >>"$GITHUB_OUTPUT"
+		echo "PUB-CACHE-KEY=$PUB_CACHE_KEY"
+		echo "PUB-CACHE-PATH=$PUB_CACHE"
+	} >>"${GITHUB_OUTPUT:-/dev/null}"
 
 	exit 0
 fi
 
-if [[ ! -x "$CACHE_PATH/bin/flutter" ]]; then
+if [ ! -x "$CACHE_PATH/bin/flutter" ]; then
-	if [[ "$CHANNEL" == "master" ]]; then
+	if [ "$CHANNEL" = "master" ] || [ "$CHANNEL" = "main" ]; then
-		git clone -b master https://github.com/flutter/flutter.git "$CACHE_PATH"
+		git clone -b "$CHANNEL" "$GIT_SOURCE" "$CACHE_PATH"
+		if [ "$VERSION" != "any" ]; then
+			git config --global --add safe.directory "$CACHE_PATH"
+			(cd "$CACHE_PATH" && git checkout "$VERSION")
+		fi
 	else
 		archive_url=$(echo "$VERSION_MANIFEST" | jq -r '.archive')
 		download_archive "$archive_url" "$CACHE_PATH"
@@ -165,11 +230,11 @@ fi
 
 {
 	echo "FLUTTER_ROOT=$CACHE_PATH"
-	echo "PUB_CACHE=$CACHE_PATH/.pub-cache"
+	echo "PUB_CACHE=$PUB_CACHE"
-} >>"$GITHUB_ENV"
+} >>"${GITHUB_ENV:-/dev/null}"
 
 {
 	echo "$CACHE_PATH/bin"
 	echo "$CACHE_PATH/bin/cache/dart-sdk/bin"
-	echo "$CACHE_PATH/.pub-cache/bin"
+	echo "$PUB_CACHE/bin"
-} >>"$GITHUB_PATH"
+} >>"${GITHUB_PATH:-/dev/null}"

test/pubspec.yaml

@@ -0,0 +1,5 @@
+name: flutter_action_test
+
+environment:
+  dart: ">=2.18.0 <3.0.0"
+  flutter: 3.3.10