use named arguments for version and arch

.github/workflows/workflow.yml

@@ -47,67 +47,81 @@ jobs:
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
-    - run: ./setup.sh -p version                    | grep -x 'stable:any:x64|stable:3.0.5:x64'
+    - run: ./setup.sh -t -p version                    | grep -x 'stable:any:x64|stable:3.0.5:x64'
       shell: bash
-    - run: ./setup.sh -p version stable             | grep -x 'stable:any:x64|stable:3.0.5:x64'
+    - run: ./setup.sh -t -p version stable             | grep -x 'stable:any:x64|stable:3.0.5:x64'
       shell: bash
-    - run: ./setup.sh -p version beta               | grep -x 'beta:any:x64|beta:3.1.0-9.0.pre:x64'
+    - run: ./setup.sh -t -p version beta               | grep -x 'beta:any:x64|beta:3.1.0-9.0.pre:x64'
       shell: bash
-    - run: ./setup.sh -p version master             | grep -x 'master:master:x64|master:master:x64'
+    - run: ./setup.sh -t -p version master             | grep -x 'master:master:x64|master:master:x64'
       shell: bash
-    - run: ./setup.sh -p version stable 2           | grep -x 'stable:2:x64|stable:2.10.5:x64'
+    - run: ./setup.sh -t -p version -n 2 stable        | grep -x 'stable:2:x64|stable:2.10.5:x64'
       shell: bash
-    - run: ./setup.sh -p version beta 2             | grep -x 'beta:2:x64|beta:2.13.0-0.4.pre:x64'
+    - run: ./setup.sh -t -p version -n 2 beta          | grep -x 'beta:2:x64|beta:2.13.0-0.4.pre:x64'
       shell: bash
-    - run: ./setup.sh -p version any 2              | grep -x 'any:2:x64|beta:2.13.0-0.4.pre:x64'
+    - run: ./setup.sh -t -p version -n 2 any           | grep -x 'any:2:x64|beta:2.13.0-0.4.pre:x64'
       shell: bash
-    - run: ./setup.sh -p version any 3              | grep -x 'any:3:x64|stable:3.0.5:x64'
+    - run: ./setup.sh -t -p version -n 3 any           | grep -x 'any:3:x64|stable:3.0.5:x64'
       shell: bash
-    - run: ./setup.sh -p version any 3 arm64        | grep -x 'any:3:arm64|stable:3.0.5:arm64'
+    - run: ./setup.sh -t -p version -n 3 -a arm64 any  | grep -x 'any:3:arm64|stable:3.0.5:arm64'
       shell: bash
-    - run: ./setup.sh -p version stable any arm64   | grep -x 'stable:any:arm64|stable:3.0.5:arm64'
+    - run: ./setup.sh -t -p version -n any -a arm64 stable | grep -x 'stable:any:arm64|stable:3.0.5:arm64'
       shell: bash
-    - run: ./setup.sh -p version stable 1           | grep -x 'stable:1:x64|stable:1.22.6:x64'
+    - run: ./setup.sh -t -p version -n 1 stable        | grep -x 'stable:1:x64|stable:1.22.6:x64'
       shell: bash
-    - run: ./setup.sh -p version stable v1          | grep -x 'stable:v1:x64|stable:v1.12.13+hotfix.9:x64'
+    - run: ./setup.sh -t -p version -n v1 stable       | grep -x 'stable:v1:x64|stable:v1.12.13+hotfix.9:x64'
       shell: bash
-    - run: ./setup.sh -p version any 0              | grep -x 'any:0:x64|beta:v0.11.13:x64'
+    - run: ./setup.sh -t -p version -n 0 any           | grep -x 'any:0:x64|beta:v0.11.13:x64'
       shell: bash
-    - run: ./setup.sh -p version any v0             | grep -x 'any:v0:x64|beta:v0.11.13:x64'
+    - run: ./setup.sh -t -p version -n v0 any          | grep -x 'any:v0:x64|beta:v0.11.13:x64'
       shell: bash
   test_cache_key:
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
-    - run: ./setup.sh -p cache-key                  | grep -x 'flutter-macos-x64-stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
+    - run: ./setup.sh -t -p cache-key                  | grep -x 'flutter-macos-stable-3.0.5-x64-f1875d570e39de09040c8f79aa13cc56baab8db1'
       shell: bash
-    - run: ./setup.sh -p cache-key stable           | grep -x 'flutter-macos-x64-stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
+    - run: ./setup.sh -t -p cache-key stable           | grep -x 'flutter-macos-stable-3.0.5-x64-f1875d570e39de09040c8f79aa13cc56baab8db1'
       shell: bash
-    - run: ./setup.sh -p cache-key beta             | grep -x 'flutter-macos-x64-beta-3.1.0-9.0.pre-f28e570c8cb12a004fae2d796d0d9cd46603bde9'
+    - run: ./setup.sh -t -p cache-key beta             | grep -x 'flutter-macos-beta-3.1.0-9.0.pre-x64-f28e570c8cb12a004fae2d796d0d9cd46603bde9'
       shell: bash
-    - run: ./setup.sh -p cache-key master           | grep -x 'flutter-macos-x64-master-master-master'
+    - run: ./setup.sh -t -p cache-key master           | grep -x 'flutter-macos-master-master-x64-master'
       shell: bash
-    - run: ./setup.sh -p cache-key stable 2         | grep -x 'flutter-macos-x64-stable-2.10.5-5464c5bac742001448fe4fc0597be939379f88ea'
+    - run: ./setup.sh -t -p cache-key -n 2 stable      | grep -x 'flutter-macos-stable-2.10.5-x64-5464c5bac742001448fe4fc0597be939379f88ea'
       shell: bash
-    - run: ./setup.sh -p cache-key beta 2           | grep -x 'flutter-macos-x64-beta-2.13.0-0.4.pre-25caf1461b8f643092a9f6f5b224453b5c057d10'
+    - run: ./setup.sh -t -p cache-key -n 2 beta        | grep -x 'flutter-macos-beta-2.13.0-0.4.pre-x64-25caf1461b8f643092a9f6f5b224453b5c057d10'
       shell: bash
-    - run: ./setup.sh -p cache-key any 2            | grep -x 'flutter-macos-x64-beta-2.13.0-0.4.pre-25caf1461b8f643092a9f6f5b224453b5c057d10'
+    - run: ./setup.sh -t -p cache-key -n 2 any         | grep -x 'flutter-macos-beta-2.13.0-0.4.pre-x64-25caf1461b8f643092a9f6f5b224453b5c057d10'
       shell: bash
-    - run: ./setup.sh -p cache-key any 3            | grep -x 'flutter-macos-x64-stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
+    - run: ./setup.sh -t -p cache-key -n 3 any         | grep -x 'flutter-macos-stable-3.0.5-x64-f1875d570e39de09040c8f79aa13cc56baab8db1'
       shell: bash
-    - run: ./setup.sh -p cache-key any 3 arm64      | grep -x 'flutter-macos-arm64-stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
+    - run: ./setup.sh -t -p cache-key -n 3 -a arm64 any      | grep -x 'flutter-macos-stable-3.0.5-arm64-f1875d570e39de09040c8f79aa13cc56baab8db1'
       shell: bash
-    - run: ./setup.sh -p cache-key stable any arm64 | grep -x 'flutter-macos-arm64-stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
+    - run: ./setup.sh -t -p cache-key -n any -a arm64 stable | grep -x 'flutter-macos-stable-3.0.5-arm64-f1875d570e39de09040c8f79aa13cc56baab8db1'
       shell: bash
-    - run: ./setup.sh -p cache-key stable 1         | grep -x 'flutter-macos-x64-stable-1.22.6-9b2d32b605630f28625709ebd9d78ab3016b2bf6'
+    - run: ./setup.sh -t -p cache-key -n 1 stable            | grep -x 'flutter-macos-stable-1.22.6-x64-9b2d32b605630f28625709ebd9d78ab3016b2bf6'
       shell: bash
-    - run: ./setup.sh -p cache-key stable v1        | grep -x 'flutter-macos-x64-stable-v1.12.13+hotfix.9-f139b11009aeb8ed2a3a3aa8b0066e482709dde3'
+    - run: ./setup.sh -t -p cache-key -n v1 stable           | grep -x 'flutter-macos-stable-v1.12.13+hotfix.9-x64-f139b11009aeb8ed2a3a3aa8b0066e482709dde3'
       shell: bash
-    - run: ./setup.sh -p cache-key any 0            | grep -x 'flutter-macos-x64-beta-v0.11.13-58c8489fcdb4e4ef6c010117584c9b23d15221aa'
+    - run: ./setup.sh -t -p cache-key -n 0 any               | grep -x 'flutter-macos-beta-v0.11.13-x64-58c8489fcdb4e4ef6c010117584c9b23d15221aa'
       shell: bash
-    - run: ./setup.sh -p cache-key any v0           | grep -x 'flutter-macos-x64-beta-v0.11.13-58c8489fcdb4e4ef6c010117584c9b23d15221aa'
+    - run: ./setup.sh -t -p cache-key -n v0 any              | grep -x 'flutter-macos-beta-v0.11.13-x64-58c8489fcdb4e4ef6c010117584c9b23d15221aa'
       shell: bash
-    - run: ./setup.sh -p cache-key -k 'custom-:channel:-:version:-:hash:'   | grep -x 'custom-stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
+    - run: ./setup.sh -t -p cache-key -k 'custom-:channel:-:version:-:hash:'   | grep -x 'custom-stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
       shell: bash
-    - run: ./setup.sh -p cache-key -k 'custom-:channel:-:version:-:sha256:' | grep -x 'custom-stable-3.0.5-e79a04dcfd1b583e5831433fc200800ba0d1e9fe4567cb661479bd2542d4c685'
+    - run: ./setup.sh -t -p cache-key -k 'custom-:channel:-:version:-:sha256:' | grep -x 'custom-stable-3.0.5-e79a04dcfd1b583e5831433fc200800ba0d1e9fe4567cb661479bd2542d4c685'
+      shell: bash
+  test_cache_path:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - run: ./setup.sh -t -p cache-path                  | grep -x '/home/runner/work/_temp/flutter/stable-3.0.5-x64'
+      shell: bash
+    - run: ./setup.sh -t -p cache-path stable           | grep -x '/home/runner/work/_temp/flutter/stable-3.0.5-x64'
+      shell: bash
+    - run: ./setup.sh -t -p cache-path beta             | grep -x '/home/runner/work/_temp/flutter/beta-3.1.0-9.0.pre-x64'
+      shell: bash
+    - run: ./setup.sh -t -p cache-path master           | grep -x '/home/runner/work/_temp/flutter/master-master-x64'
+      shell: bash
+    - run: ./setup.sh -t -p cache-path -c '/tmp/flutter/:channel:-:version:-:hash:' | grep -x '/tmp/flutter/stable-3.0.5-f1875d570e39de09040c8f79aa13cc56baab8db1'
       shell: bash

README.md

@@ -23,7 +23,7 @@ steps:
 - uses: actions/checkout@v3
 - uses: subosito/flutter-action@v2
   with:
-    channel: 'stable' # or: 'beta' or 'master'
+    channel: 'stable' # or: 'beta', 'dev' or 'master'
 - run: flutter --version
 ```
 
@@ -157,17 +157,17 @@ steps:
   with:
     channel: 'stable'
     cache: true
-    cache-key: 'flutter-:os:-:arch:-:channel:-:version:-:hash:' # optional, change this to force refresh cache
-    cache-path: ${{ runner.tool_cache }}/flutter # optional, change this to specify the cache path
+    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
     architecture: x64 # optional, x64 or arm64
 - run: flutter --version
 ```
 
-Note: `cache-key` has support for several dynamic values:
+Note: `cache-key` and `cache-path` has support for several dynamic values:
 
 - `:os:`
-- `:arch:`
 - `:channel:`
 - `:version:`
+- `:arch:`
 - `:hash:`
 - `:sha256:`

action.yml

@@ -16,14 +16,15 @@ inputs:
   cache:
     description: 'Cache the Flutter SDK'
     required: false
+    default: false
   cache-key:
     description: 'Identifier for the Flutter SDK cache'
     required: false
-    default: 'flutter-:os:-:arch:-:channel:-:version:-:hash:'
+    default: 'flutter-: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:'
   architecture:
     description: 'The architecture of Flutter SDK executable (x64 or arm64)'
     required: false
@@ -31,14 +32,17 @@ inputs:
 runs:
   using: 'composite'
   steps:
+    - id: flutter-action-cache-path-builder
+      run: echo "::set-output name=cache-path::$($GITHUB_ACTION_PATH/setup.sh -p cache-path -c '${{ inputs.cache-path }}' -n '${{ inputs.flutter-version }}' -a '${{ inputs.architecture }}' ${{ inputs.channel }})"
+      shell: bash
     - if: ${{ inputs.cache == 'true' }}
       id: flutter-action-cache-key-builder
-      run: echo "::set-output name=cache-key::$($GITHUB_ACTION_PATH/setup.sh -p cache-key -k ${{ inputs.cache-key }} ${{ inputs.channel }} ${{ inputs.flutter-version }} ${{ inputs.architecture }})"
+      run: echo "::set-output name=cache-key::$($GITHUB_ACTION_PATH/setup.sh -p cache-key -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: ${{ inputs.cache-path }}
+        path: ${{ steps.flutter-action-cache-path-builder.outputs.cache-path }}
         key: ${{ steps.flutter-action-cache-key-builder.outputs.cache-key }}
-    - run: $GITHUB_ACTION_PATH/setup.sh -c "${{ inputs.cache-path }}" ${{ inputs.channel }} ${{ inputs.flutter-version }} ${{ inputs.architecture }}
+    - run: $GITHUB_ACTION_PATH/setup.sh -c '${{ steps.flutter-action-cache-path-builder.outputs.cache-path }}' -n '${{ inputs.flutter-version }}' -a '${{ inputs.architecture }}' ${{ inputs.channel }}
       shell: bash

setup.sh

@@ -12,7 +12,7 @@ fi
 OS_NAME=$(echo "$RUNNER_OS" | 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_TEST_FIXTURE="test/releases_$OS_NAME.json"
+MANIFEST_TEST_FIXTURE="$(dirname -- "${BASH_SOURCE[0]}")/test/releases_$OS_NAME.json"
 
 legacy_wildcard_version() {
 	if [[ $1 == any ]]; then
@@ -88,29 +88,30 @@ download_archive() {
 CACHE_PATH=""
 CACHE_KEY=""
 PRINT_MODE=""
+USE_TEST_FIXTURE=false
+ARCH=""
+VERSION=""
 
-while getopts 'c:k:p:' flag; do
+while getopts 'tc:k:p:a:n:' flag; do
 	case "$flag" in
 	c) CACHE_PATH="$OPTARG" ;;
 	k) CACHE_KEY="$OPTARG" ;;
 	p) PRINT_MODE="$OPTARG" ;;
+	t) USE_TEST_FIXTURE=true ;;
+	a) ARCH="$(echo "$OPTARG" | awk '{print tolower($0)}')" ;;
+	n) VERSION="$OPTARG" ;;
 	?) exit 2 ;;
 	esac
 done
 
 ARR_CHANNEL=("${@:$OPTIND:1}")
-ARR_VERSION=("${@:$OPTIND+1:1}")
-ARR_ARCH=("${@:$OPTIND+2:1}")
-
 CHANNEL="${ARR_CHANNEL[0]}"
-VERSION="${ARR_VERSION[0]}"
-ARCH=$(echo "${ARR_ARCH[0]}" | awk '{print tolower($0)}')
 
 [[ -z $CHANNEL ]] && CHANNEL=stable
 [[ -z $VERSION ]] && VERSION=any
 [[ -z $ARCH ]] && ARCH=x64
-[[ -z $CACHE_PATH ]] && CACHE_PATH=/tmp
-[[ -z $CACHE_KEY ]] && CACHE_KEY="flutter-:os:-:arch:-:channel:-:version:-:hash:"
+[[ -z $CACHE_PATH ]] && CACHE_PATH="$RUNNER_TEMP/flutter/:channel:-:version:-:arch:"
+[[ -z $CACHE_KEY ]] && CACHE_KEY="flutter-:os:-:channel:-:version:-:arch:-:hash:"
 
 RELEASE_MANIFEST=""
 VERSION_MANIFEST=""
@@ -165,18 +166,32 @@ if [[ -n "$PRINT_MODE" ]]; then
 			exit 0
 		fi
 
-		if [[ "$PRINT_MODE" == cache-key ]]; then
-			VERSION_MANIFEST="{\"channel\":\"$CHANNEL\",\"version\":\"$CHANNEL\",\"dart_sdk_arch\":\"$ARCH\",\"hash\":\"$CHANNEL\",\"sha256\":\"$CHANNEL\"}"
-			EXPANDED_KEY=$(expand_key "$CACHE_KEY")
+		VERSION_MANIFEST="{\"channel\":\"$CHANNEL\",\"version\":\"$CHANNEL\",\"dart_sdk_arch\":\"$ARCH\",\"hash\":\"$CHANNEL\",\"sha256\":\"$CHANNEL\"}"
 
-			echo "$EXPANDED_KEY"
+		if [[ "$PRINT_MODE" == cache-key ]]; then
+			expanded_key=$(expand_key "$CACHE_KEY")
+
+			echo "$expanded_key"
+			exit 0
+		fi
+
+		if [[ "$PRINT_MODE" == cache-path ]]; then
+			cache_path=$(transform_path "$CACHE_PATH")
+			expanded_path=$(expand_key "$cache_path")
+
+			echo "$expanded_path"
 			exit 0
 		fi
 
 		exit 1
 	fi
 
-	RELEASE_MANIFEST=$(cat "$MANIFEST_TEST_FIXTURE")
+	if [[ "$USE_TEST_FIXTURE" == true ]]; then
+		RELEASE_MANIFEST=$(cat "$MANIFEST_TEST_FIXTURE")
+	else
+		RELEASE_MANIFEST=$(curl --silent --connect-timeout 15 --retry 5 "$MANIFEST_URL")
+	fi
+
 	VERSION_MANIFEST=$(get_version_manifest)
 
 	if [[ -z "$VERSION_MANIFEST" ]]; then
@@ -190,9 +205,17 @@ if [[ -n "$PRINT_MODE" ]]; then
 	fi
 
 	if [[ "$PRINT_MODE" == cache-key ]]; then
-		EXPANDED_KEY=$(expand_key "$CACHE_KEY")
+		expanded_key=$(expand_key "$CACHE_KEY")
 
-		echo "$EXPANDED_KEY"
+		echo "$expanded_key"
+		exit 0
+	fi
+
+	if [[ "$PRINT_MODE" == cache-path ]]; then
+		cache_path=$(transform_path "$CACHE_PATH")
+		expanded_path=$(expand_key "$cache_path")
+
+		echo "$expanded_path"
 		exit 0
 	fi