fix: specify pub cache path (#280 )

Update README (#266 )
* doc: Update README * fix: Specify the dev channel version
2026-07-18 18:50:52 +02:00 · 2024-03-20 11:20:53 +07:00 · 2024-02-13 07:52:27 +07:00 · 2024-02-13 07:13:38 +07:00 · 2024-02-05 09:06:33 +07:00 · 2023-11-20 16:29:45 +07:00
8 changed files with 14139 additions and 210 deletions
@@ -1 +1 @@
-open_collective: flutter-action
+github: [subosito]
@@ -3,99 +3,144 @@ on:
  push:
    branches:
      - main
+      - dev
  pull_request:
-    branches:
-      - main
+    paths:
+      - setup.sh
+      - action.yml
 jobs:
+  lint_shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - 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]
+        channel: [stable, beta, master]
+        include:
+          - operating-system: ubuntu-latest
+            channel: main
    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-    - uses: ./
+    - uses: actions/checkout@v4
+    - id: flutter-action
+      uses: ./
      with:
        channel: ${{ matrix.channel }}
-    - name: Print FLUTTER_ROOT
+    - 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: echo "FLUTTER_ROOT set to $FLUTTER_ROOT"
-    - name: Print PUB_CACHE
+    - run: dart --version
      shell: bash
-      run: echo "PUB_CACHE set to $PUB_CACHE"
-    - name: Run dart --version
+    - run: flutter --version
      shell: bash
-      run: dart --version
-    - name: Run flutter --version
-      shell: bash
-      run: flutter --version
-  test_version:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        version: [ 2.5.3, 2.x, 1, v1.12 ]
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-    - uses: ./
-      with:
-        channel: stable
-        flutter-version: ${{ matrix.version }}
-    - name: Run dart --version
-      shell: bash
-      run: dart --version
-    - name: Run flutter --version
-      shell: bash
-      run: flutter --version
-  test_master_channel:
-    runs-on: windows-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-    - uses: ./
-      with:
-        channel: master
-    - name: Run dart --version
-      shell: bash
-      run: dart --version
-    - name: Run flutter --version
-      shell: bash
-      run: flutter --version
-  test_any_channel:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-    - uses: ./
-      with:
-        channel: any
-        flutter-version: 2
-    - name: Run dart --version
-      shell: bash
-      run: dart --version
-    - name: Run flutter --version
-      shell: bash
-      run: flutter --version
  test_cache:
    runs-on: ${{ matrix.operating-system }}
    strategy:
      matrix:
        operating-system: [ubuntu-latest, windows-latest, macos-latest]
    steps:
-    - name: Checkout
-      uses: actions/checkout@v3
+    - uses: actions/checkout@v4
    - uses: ./
      with:
        channel: stable
-        flutter-version: 2.5.0
+        flutter-version: '3.10.6'
        cache: true
-        cache-key: key-20220113
-        cache-path: ${{ runner.tool_cache }}/flutter/2.5.0-stable
-    - name: Run dart --version
+    - run: dart --version
      shell: bash
-      run: dart --version
-    - name: Run flutter --version
+    - run: flutter --version
+      shell: bash
+  test_print_output:
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v4
+    - 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-any-x64-master'
+      shell: bash
+    - run: ./setup.sh -t -p -n 5b12b74 master      | grep 'flutter-macos-master-5b12b74-x64-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-x64-master'
+      shell: bash
+    - run: ./setup.sh -t -p -n stable master       | grep 'flutter-macos-master-stable-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-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-78957b52f023a0d811add27eddc59b1a59d27d2ada5df123f39d0315708fb2d5'
+      shell: bash
+    - run: ./setup.sh -t -p -c '/tmp/flutter/:channel:-:version:-:hash:' | grep '/tmp/flutter/stable-3.7.7-2ad6cd72c040113b47ee9055e722606a490ef0da'
      shell: bash
-      run: flutter --version
@@ -8,10 +8,10 @@ Use specific version and channel:

 ```yaml
 steps:
- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
  with:
-    flutter-version: '2.8.0'
+    flutter-version: '3.16.9'
    channel: 'stable'
 - run: flutter --version
 ```
@@ -20,10 +20,10 @@ Use latest release for particular channel:

 ```yaml
 steps:
- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
  with:
-    channel: 'stable' # or: 'beta' or 'master'
+    channel: 'stable' # or: 'beta', 'dev', 'master' (or 'main')
 - run: flutter --version
 ```

@@ -31,10 +31,10 @@ Use latest release for particular version and/or channel:

 ```yaml
 steps:
- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
  with:
-    flutter-version: '1.22.x' # or, you can use 1.22
+    flutter-version: '1.22.x'
    channel: 'dev'
 - run: flutter --version
 ```
@@ -43,26 +43,34 @@ Use particular version on any channel:

 ```yaml
 steps:
- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
  with:
-    flutter-version: '2.x'
+    flutter-version: '3.x'
    channel: 'any'
 - run: flutter --version
 ```

+Use particular git reference on master channel:
+
+```yaml
+steps:
+- uses: actions/checkout@v4
+- uses: subosito/flutter-action@v2
+  with:
+    flutter-version: '5b12b74' # tag, commit or branch
+    channel: 'master'
+- run: flutter --version
+```
+
 Build Android APK and app bundle:

 ```yaml
 steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v2
-  with:
-    distribution: 'zulu'
-    java-version: '11'
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
  with:
-    flutter-version: '2.10.4'
+    flutter-version: '3.16.9'
 - run: flutter pub get
 - run: flutter test
 - run: flutter build apk
@@ -76,11 +84,10 @@ jobs:
  build:
    runs-on: macos-latest
    steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
    - uses: subosito/flutter-action@v2
      with:
-        flutter-version: '2.10.4'
-        architecture: x64
+        channel: 'stable'
    - run: flutter pub get
    - run: flutter test
    - run: flutter build ios --release --no-codesign
@@ -90,10 +97,10 @@ Build for the web:

 ```yaml
 steps:
- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
  with:
-    flutter-version: '2.10.4'
+    channel: 'stable'
 - run: flutter pub get
 - run: flutter test
 - run: flutter build web
@@ -106,11 +113,10 @@ jobs:
 build:
   runs-on: windows-latest
   steps:
-     - uses: actions/checkout@v3
+     - uses: actions/checkout@v4
     - uses: subosito/flutter-action@v2
       with:
-         channel: 'beta'
-     - run: flutter config --enable-windows-desktop
+         channel: 'stable'
     - run: flutter build windows
 ```

@@ -121,14 +127,13 @@ jobs:
 build:
   runs-on: ubuntu-latest
   steps:
-     - uses: actions/checkout@v3
+     - uses: actions/checkout@v4
     - uses: subosito/flutter-action@v2
       with:
-         channel: 'beta'
+         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
 ```

@@ -139,12 +144,10 @@ jobs:
 build:
   runs-on: macos-latest
   steps:
-     - uses: actions/checkout@v3
+     - uses: actions/checkout@v4
     - uses: subosito/flutter-action@v2
       with:
-         channel: 'beta'
-         architecture: x64
-     - run: flutter config --enable-macos-desktop
+         channel: 'stable'
     - run: flutter build macos
 ```

@@ -152,14 +155,43 @@ Integration with `actions/cache`:

 ```yaml
 steps:
- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
  with:
-    flutter-version: '2.10.x'
    channel: 'stable'
    cache: true
-    cache-key: flutter # optional, change this to force refresh cache
-    cache-path: ${{ runner.tool_cache }}/flutter # optional, change this to specify the cache path
-    architecture: x64 # optional, x64 or arm64
+    cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:' # optional, change this to force refresh cache
+    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`, `pub-cache-key`, and `cache-path` has support for several dynamic values:
+
+- `:os:`
+- `:channel:`
+- `:version:`
+- `:arch:`
+- `:hash:`
+- `:sha256:`
+
+Use outputs from `flutter-action`:
+
+```yaml
+steps:
+- uses: actions/checkout@v4
+- id: flutter-action
+  uses: subosito/flutter-action@v2
+  with:
+    channel: 'stable'
+- 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 }}
+  shell: bash
+```
@@ -16,25 +16,64 @@ inputs:
  cache:
    description: 'Cache the Flutter SDK'
    required: false
+    default: 'false'
  cache-key:
    description: 'Identifier for the Flutter SDK cache'
    required: false
-    default: 'flutter'
+    default: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
+  pub-cache-key:
+    description: 'Identifier for the Dart .pub-cache cache'
+    required: false
+    default: 'flutter-pub:os:-:channel:-:version:-:arch:-:hash:'
  cache-path:
    description: 'Flutter SDK cache path'
    required: false
-    default: ${{ runner.tool_cache }}/flutter
+    default: '${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:'
+  pub-cache-path:
+    description: 'Flutter pub cache path'
+    required: false
+    default: 'default'
  architecture:
    description: 'The architecture of Flutter SDK executable (x64 or arm64)'
    required: false
-    default: 'x64'
+    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 }}'
+  PUB-CACHE-KEY:
+    value: '${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}'
+  PUB-CACHE-PATH:
+    value: '${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}'
 runs:
  using: 'composite'
  steps:
+    - run: chmod +x $GITHUB_ACTION_PATH/setup.sh
+      shell: bash
+    - id: flutter-action
+      run: $GITHUB_ACTION_PATH/setup.sh -p -c '${{ inputs.cache-path }}' -k '${{ inputs.cache-key }}' -d '${{ inputs.pub-cache-path }}' -l '${{ inputs.pub-cache-key }}' -n '${{ inputs.flutter-version }}' -a '${{ inputs.architecture }}' ${{ inputs.channel }}
+      shell: bash
    - if: ${{ inputs.cache == 'true' }}
-      uses: actions/cache@v2
+      uses: actions/cache@v4
      with:
-        path: ${{ inputs.cache-path }}
-        key: ${{ inputs.cache-key }}-${{ inputs.channel }}-${{ inputs.flutter-version }}
-    - run: $GITHUB_ACTION_PATH/setup.sh -c "${{ inputs.cache-path }}" ${{ inputs.channel }} ${{ inputs.flutter-version }} ${{ inputs.architecture }}
+        path: ${{ steps.flutter-action.outputs.CACHE-PATH }}
+        key: ${{ steps.flutter-action.outputs.CACHE-KEY }}
+        restore-keys: |
+          ${{ steps.flutter-action.outputs.CACHE-KEY }}
+    - if: ${{ inputs.cache == 'true' }}
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}
+        key: ${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
+        restore-keys: |
+          ${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
+          ${{ steps.flutter-action.outputs.PUB-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
@@ -1,122 +1,211 @@
 #!/bin/bash

+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/"
+	exit 1
+fi
+
 OS_NAME=$(echo "$RUNNER_OS" | awk '{print tolower($0)}')
+ARCH_NAME=$(echo "$RUNNER_ARCH" | awk '{print tolower($0)}')
 MANIFEST_BASE_URL="https://storage.googleapis.com/flutter_infra_release/releases"
-MANIFEST_URL="${MANIFEST_BASE_URL}/releases_${OS_NAME}.json"
+MANIFEST_JSON_PATH="releases_$OS_NAME.json"
+MANIFEST_URL="$MANIFEST_BASE_URL/$MANIFEST_JSON_PATH"

-# convert version like 2.5.x to 2.5
-normalize_version() {
-  if [[ $1 == *x ]]; then
-    echo ${1::-2}
-  else
-    echo $1
-  fi
+filter_by_channel() {
+	jq --arg channel "$1" '[.releases[] | select($channel == "any" or .channel == $channel)]'
 }

-latest_version() {
-  jq --arg channel "$1" --arg arch "$ARCH" '.releases | map(select(.channel==$channel) | select(.dart_sdk_arch == null or .dart_sdk_arch == $arch)) | first'
+filter_by_arch() {
+	jq --arg arch "$1" '[.[] | select(.dart_sdk_arch == $arch or ($arch == "x64" and (has("dart_sdk_arch") | not)))]'
 }

-wildcard_version() {
-  if [ $2 == *"v"* ]; then  # is legacy version format
-    if [[ $1 == any ]]; then
-    jq --arg version "$2" '.releases | map(select(.version | startswith($version) )) | first'
-    else
-    jq --arg channel "$1" --arg version "$2" '.releases | map(select(.channel==$channel) | select(.version | startswith($version) )) | first'
-    fi
-  elif [[ $1 == any ]]; then
-    jq --arg version "$2" --arg arch "$ARCH" '.releases | map(select(.version | startswith($version)) | select(.dart_sdk_arch == null or .dart_sdk_arch == $arch)) | first'    
-  else
-    jq --arg channel "$1" --arg version "$2" --arg arch "$ARCH" '.releases | map(select(.channel==$channel) | select(.version | startswith($version) ) | select(.dart_sdk_arch == null or .dart_sdk_arch == $arch)) | first'
-  fi
+filter_by_version() {
+	jq --arg version "$1" '.[].version |= gsub("^v"; "") | (if $version == "any" then .[0] else (map(select(.version == $version or (.version | startswith(($version | sub("\\.x$"; "")) + ".")) and .version != $version)) | .[0]) end)'
 }

-get_version() {
-  if [[ $2 == any ]]; then
-    latest_version $1
-  else
-    wildcard_version $1 $2
-  fi
-}
-
-get_version_manifest() {
-  releases_manifest=$(curl --silent --connect-timeout 15 --retry 5 $MANIFEST_URL)
-  version_manifest=$(echo $releases_manifest | get_version $1 $(normalize_version $2))
-
-  if [[ $version_manifest == null ]]; then
-    # fallback through legacy version format
-    echo $releases_manifest | wildcard_version $1 "v$(normalize_version $2)"
-  else
-    echo $version_manifest
-  fi
-}
-
-download_archive() {
-  archive_url="$MANIFEST_BASE_URL/$1"
-  archive_name=$(basename $1)
-  archive_local="$RUNNER_TEMP/$archive_name"
-
-  curl --connect-timeout 15 --retry 5 $archive_url >$archive_local
-
-  # Create the target folder
-  mkdir -p "$2"
-
-  if [[ $archive_name == *zip ]]; then
-    unzip -q -o "$archive_local" -d "$RUNNER_TEMP"
-    # 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"
-  else
-    tar xf "$archive_local" -C "$2" --strip-components=1
-  fi
-
-  rm $archive_local
+not_found_error() {
+	echo "Unable to determine Flutter version for channel: $1 version: $2 architecture: $3"
 }

 transform_path() {
-  if [[ $OS_NAME == windows ]]; then
-    echo $1 | sed -e 's/^\///' -e 's/\//\\/g'
-  else
-    echo $1
-  fi
+	if [[ "$OS_NAME" == windows ]]; then
+		echo "$1" | sed -e 's/^\///' -e 's/\//\\/g'
+	else
+		echo "$1"
+	fi
+}
+
+download_archive() {
+	archive_url="$MANIFEST_BASE_URL/$1"
+	archive_name=$(basename "$1")
+	archive_local="$RUNNER_TEMP/$archive_name"
+
+	curl --connect-timeout 15 --retry 5 "$archive_url" >"$archive_local"
+
+	mkdir -p "$2"
+
+	if [[ "$archive_name" == *zip ]]; then
+		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 "$EXTRACT_PATH"/flutter "$2"
+		rm -r "$EXTRACT_PATH"
+	else
+		tar xf "$archive_local" -C "$2" --strip-components=1
+	fi
+
+	rm "$archive_local"
 }

 CACHE_PATH=""
+CACHE_KEY=""
+PUB_CACHE_PATH=""
+PUB_CACHE_KEY=""
+PRINT_ONLY=""
+TEST_MODE=false
+ARCH=""
+VERSION=""

-while getopts 'c:' flag; do
-  case "${flag}" in
-  c) CACHE_PATH="$OPTARG" ;;
-  ?) exit 2 ;;
-  esac
+while getopts 'tc:k:d:l:pa:n:' 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" ;;
+	?) exit 2 ;;
+	esac
 done

-CHANNEL="${@:$OPTIND:1}"
-VERSION="${@:$OPTIND+1:1}"
-ARCH="${@:$OPTIND+2:1}"
+[[ -z $ARCH ]] && ARCH="$ARCH_NAME"

-SDK_CACHE="$(transform_path ${CACHE_PATH})"
-PUB_CACHE="$(transform_path ${CACHE_PATH}/.pub-cache)"
+ARR_CHANNEL=("${@:$OPTIND:1}")
+CHANNEL="${ARR_CHANNEL[0]}"

-if [[ ! -x "${SDK_CACHE}/bin/flutter" ]]; then
-  if [[ $CHANNEL == master ]]; then
-    git clone -b master https://github.com/flutter/flutter.git "$SDK_CACHE"
-  else
-    VERSION_MANIFEST=$(get_version_manifest $CHANNEL $VERSION)
-    if [[ $VERSION_MANIFEST == null ]]; then
-      echo "Unable to determine Flutter version for channel: $CHANNEL version: $VERSION architecture: $ARCH"
-      exit 1
-     fi
-    ARCHIVE_PATH=$(echo $VERSION_MANIFEST | jq -r '.archive')
-    download_archive "$ARCHIVE_PATH" "$SDK_CACHE"
-  fi
+[[ -z $CHANNEL ]] && CHANNEL=stable
+[[ -z $VERSION ]] && VERSION=any
+[[ -z $ARCH ]] && ARCH=x64
+[[ -z $CACHE_PATH ]] && CACHE_PATH="$RUNNER_TEMP/flutter/:channel:-:version:-:arch:"
+[[ -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"
+
+# `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

-echo "FLUTTER_ROOT=${SDK_CACHE}" >>$GITHUB_ENV
-echo "PUB_CACHE=${PUB_CACHE}" >>$GITHUB_ENV
+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

-echo "${SDK_CACHE}/bin" >>$GITHUB_PATH
-echo "${SDK_CACHE}/bin/cache/dart-sdk/bin" >>$GITHUB_PATH
-echo "${PUB_CACHE}/bin" >>$GITHUB_PATH
+if [[ "$CHANNEL" == "master" || "$CHANNEL" == "main" ]]; then
+	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
+	not_found_error "$CHANNEL" "$VERSION" "$ARCH"
+	exit 1
+fi
+
+expand_key() {
+	version_channel=$(echo "$VERSION_MANIFEST" | jq -r '.channel')
+	version_version=$(echo "$VERSION_MANIFEST" | jq -r '.version')
+	version_arch=$(echo "$VERSION_MANIFEST" | jq -r '.dart_sdk_arch // "x64"')
+	version_hash=$(echo "$VERSION_MANIFEST" | jq -r '.hash')
+	version_sha_256=$(echo "$VERSION_MANIFEST" | jq -r '.sha256')
+
+	expanded_key="${1/:channel:/$version_channel}"
+	expanded_key="${expanded_key/:version:/$version_version}"
+	expanded_key="${expanded_key/:arch:/$version_arch}"
+	expanded_key="${expanded_key/:hash:/$version_hash}"
+	expanded_key="${expanded_key/:sha256:/$version_sha_256}"
+	expanded_key="${expanded_key/:os:/$OS_NAME}"
+
+	echo "$expanded_key"
+}
+
+CACHE_KEY=$(expand_key "$CACHE_KEY")
+PUB_CACHE_KEY=$(expand_key "$PUB_CACHE_KEY")
+CACHE_PATH=$(expand_key "$(transform_path "$CACHE_PATH")")
+
+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
+		echo "CHANNEL=$info_channel"
+		echo "VERSION=$info_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"
+		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"
+	} >>"$GITHUB_OUTPUT"
+
+	exit 0
+fi
+
+if [[ ! -x "$CACHE_PATH/bin/flutter" ]]; then
+	if [[ "$CHANNEL" == "master" || "$CHANNEL" == "main" ]]; then
+		git clone -b "$CHANNEL" https://github.com/flutter/flutter.git "$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"
+	fi
+fi
+
+{
+	echo "FLUTTER_ROOT=$CACHE_PATH"
+	echo "PUB_CACHE=$PUB_CACHE"
+} >>"$GITHUB_ENV"
+
+{
+	echo "$CACHE_PATH/bin"
+	echo "$CACHE_PATH/bin/cache/dart-sdk/bin"
+	echo "$PUB_CACHE/bin"
+} >>"$GITHUB_PATH"
Author	SHA1	Message	Date
Richard ShiueandGitHub	1c5eb12d81	fix: specify pub cache path (#280 )	2024-03-20 11:20:53 +07:00
Koji WakamiyaandGitHub	62f096cacd	Update README (#266 ) * doc: Update README * fix: Specify the dev channel version	2024-02-13 07:52:27 +07:00
Jørgen TjernøandGitHub	844082558d	Improvements to caching (#265 ) * Bump actions/cache to v4 to suppress node warnings * Respect `PUB_CACHE` from the environment * Cache pub-cache separately from flutter In order to reduce the extra work that happens when you update your pubspec.lock, don't use `hashFiles('*/pubspec.lock')` in the hash of the flutter installation, and separately cache the `.pubspec-cache`. Also return the `.pub-cache` to `$HOME`, since it's not part of the tool installation. Fix README example of pub-cache-path and document `PUB_CACHE`	2024-02-13 07:13:38 +07:00
Koji WakamiyaandGitHub	14bf5302ef	Set architecture options from runner's architecture (#264 ) * feat: Add ARCH_NAME variable and set default ARCH value * chore: Show runner's os and architecture * chore: Update actions	2024-02-05 09:06:33 +07:00
Devon CarewandGitHub	02b923c0e1	add support for the `main` channel (#258 ) * add support for the main channel * update testing for the 'main' channel	2023-11-20 16:29:45 +07:00
Alif Rachmawadi	aa6d9b9844	update cache test	2023-11-01 18:11:33 +07:00
Alif Rachmawadi	2783a3f08e	ensure setup.sh executable; fixes #245	2023-11-01 17:59:30 +07:00
Daren HaywardandGitHub	c33c37022b	Extract to a temporary location to enable moving of flutter folder. (#227 )	2023-11-01 17:50:15 +07:00
Gustl22andGitHub	cc97e1648f	feat: Allow git ref as version in `master` channel (#237 ) * feat: Allow git ref as version in `master` channel * fix lint * fix parsing * fix test * fix checkout, add tests * replace with tab	2023-10-11 15:55:21 +07:00
Alif Rachmawadi	ed388baf1d	fixes #224 ; update readme	2023-06-24 16:31:51 +07:00
Alif Rachmawadi	48cafc2471	re-add master channel support	2023-03-23 05:52:25 +07:00
Alif Rachmawadi	1508160852	adjust filter by arch	2023-03-22 08:45:49 +07:00
Alif Rachmawadi	88cab4064b	add restore-keys cache support	2023-03-21 22:20:05 +07:00
Alif Rachmawadi	55a58f6493	make simpler	2023-03-21 21:49:20 +07:00
Alif Rachmawadi	d369dd765d	make simpler	2023-03-21 21:46:00 +07:00
Alif Rachmawadi	42b3ed07e1	make simpler	2023-03-21 21:45:02 +07:00
Alif Rachmawadi	8dbc29a898	make simpler	2023-03-21 21:42:52 +07:00
Alif Rachmawadi	ed0e860e8f	make simpler	2023-03-21 21:37:50 +07:00
Alif Rachmawadi	37734c707c	update test fixtures	2023-03-21 21:31:03 +07:00
Alif Rachmawadi	b1ba330d99	update test fixtures	2023-03-21 21:25:27 +07:00
Alif Rachmawadi	43c32c5d3a	update test fixtures	2023-03-21 20:55:50 +07:00
Alif RachmawadiandGitHub	dbf1fa04f4	Replace set-output with $GITHUB_OUTPUT; fixes #192 (#194 ) * replace set-output with $GITHUB_OUTPUT * use stdout for test mode * update readme	2022-10-13 06:31:27 +07:00
Adrien PadolandGitHub	1e6ee87cb8	Added missing parameter for cache-key (#187 )	2022-09-17 07:11:03 +07:00
Alif Rachmawadi	45dd344cec	github sponsor	2022-09-08 11:37:17 +07:00
Alif Rachmawadi	de3cdb9a4b	enhance set output	2022-09-08 09:12:35 +07:00
Alif Rachmawadi	1e952778af	enhance set output	2022-09-08 00:57:19 +07:00
Alif Rachmawadi	9d48f4efd5	use named arguments for version and arch	2022-08-25 17:24:16 +07:00
Alif Rachmawadi	6c2e035f26	fix test manifest load	2022-07-26 17:47:54 +07:00
Alif Rachmawadi	c30358aafe	dynamic cache path	2022-07-26 13:20:39 +07:00
Alif Rachmawadi	472d887f68	update readme	2022-07-26 11:56:47 +07:00
Alif Rachmawadi	b1d33bca25	print version	2022-07-25 19:47:52 +07:00
Alif Rachmawadi	e5fb13927b	update readme	2022-07-25 19:36:41 +07:00
Alif Rachmawadi	ebff0a3874	tidy up	2022-07-25 19:15:22 +07:00
Alif Rachmawadi	d8cf9a8ccc	tidy up	2022-07-25 18:58:09 +07:00
Alif Rachmawadi	e09ab0131a	remove opencollective	2022-07-24 21:17:47 +07:00
Alif Rachmawadi	becfb71246	shellcheck linter	2022-07-24 19:30:59 +07:00
Alif RachmawadiandGitHub	54864698df	test mode and cache key builder (#175 )	2022-07-24 19:19:31 +07:00
Alif Rachmawadi	ea686d7c56	check jq	2022-07-19 12:00:34 +07:00
Alif Rachmawadi	9c6ea81337	check jq, fixes #170	2022-07-19 06:32:29 +07:00
Jiun KimandGitHub	29ad5bdaf4	Update for any-version on any-channel (#155 ) * Update for testing any-version on any-channel * Update `latest_version` and Add `latest_channel_version`	2022-06-05 16:06:25 +07:00
Jiun KimandGitHub	0c3f14223a	Update cache-key with `Runner.os` and `Arch` (#152 ) * Add `${{ runner.os }}` on cache-key * Add `${{ inputs.architecture }}` as Cache-key	2022-04-29 09:03:21 +07:00
Jiun KimandGitHub	0f2cd3391b	Update architecture default as `runner.arch` (#153 ) * Update architecture default as `runner.arch` * Update to convert `ARCH` as lowercase * Refactor for `ARCH` variable	2022-04-29 07:52:26 +07:00
Jiun KimandGitHub	cf0b7b2cac	Update for `actions/cache` version to 3 (#150 )	2022-04-27 10:24:59 +07:00