Update README (#266)

* doc: Update README

* fix: Specify the dev channel version

.github/workflows/workflow.yml

@@ -12,7 +12,7 @@ jobs:
   lint_shellcheck:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ludeeus/action-shellcheck@master
   test_channel:
     runs-on: ${{ matrix.operating-system }}
@@ -20,14 +20,20 @@ jobs:
       matrix:
         operating-system: [ubuntu-latest, windows-latest, macos-latest]
         channel: [stable, beta, master]
+        include:
+          - operating-system: ubuntu-latest
+            channel: main
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - id: flutter-action
       uses: ./
       with:
         channel: ${{ matrix.channel }}
     - 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 }}
@@ -44,10 +50,11 @@ jobs:
       matrix:
         operating-system: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ./
       with:
         channel: stable
+        flutter-version: '3.10.6'
         cache: true
     - run: dart --version
       shell: bash
@@ -56,7 +63,7 @@ jobs:
   test_print_output:
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - run: ./setup.sh -t -p                        | grep 'stable'
       shell: bash
     - run: ./setup.sh -t -p                        | grep '3.7.7'
@@ -107,7 +114,13 @@ jobs:
       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'
+    - 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
@@ -123,7 +136,7 @@ jobs:
       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'
+    - 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

README.md

@@ -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: '3.7.7'
+    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', 'dev' or 'master'
+    channel: 'stable' # or: 'beta', 'dev', 'master' (or 'main')
 - run: flutter --version
 ```
 
@@ -31,7 +31,7 @@ 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'
@@ -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: '3.7.7'
+    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:
         channel: 'stable'
-        architecture: x64
     - run: flutter pub get
     - run: flutter test
     - run: flutter build ios --release --no-codesign
@@ -90,7 +97,7 @@ Build for the web:
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
   with:
     channel: 'stable'
@@ -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: '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: 'stable'
-         architecture: x64
-     - run: flutter config --enable-macos-desktop
      - run: flutter build macos
 ```
 
@@ -152,18 +155,19 @@ Integration with `actions/cache`:
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - uses: subosito/flutter-action@v2
   with:
     channel: 'stable'
     cache: true
     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
+    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` has support for several dynamic values:
 
 - `:os:`
 - `:channel:`
@@ -176,7 +180,7 @@ Use outputs from `flutter-action`:
 
 ```yaml
 steps:
-- uses: actions/checkout@v3
+- uses: actions/checkout@v4
 - id: flutter-action
   uses: subosito/flutter-action@v2
   with:
@@ -187,5 +191,7 @@ steps:
     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
 ```

action.yml

@@ -16,11 +16,15 @@ inputs:
   cache:
     description: 'Cache the Flutter SDK'
     required: false
-    default: false
+    default: 'false'
   cache-key:
     description: 'Identifier for the Flutter SDK cache'
     required: false
     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
@@ -40,19 +44,32 @@ outputs:
     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 }}' -n '${{ inputs.flutter-version }}' -a '${{ inputs.architecture }}' ${{ inputs.channel }}
+      run: $GITHUB_ACTION_PATH/setup.sh -p -c '${{ inputs.cache-path }}' -k '${{ inputs.cache-key }}' -d '${{ inputs.pub-cache-key }}' -n '${{ inputs.flutter-version }}' -a '${{ inputs.architecture }}' ${{ inputs.channel }}
       shell: bash
     - if: ${{ inputs.cache == 'true' }}
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.flutter-action.outputs.CACHE-PATH }}
-        key: ${{ steps.flutter-action.outputs.CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
+        key: ${{ steps.flutter-action.outputs.CACHE-KEY }}
         restore-keys: |
-          ${{ steps.flutter-action.outputs.CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
           ${{ 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

setup.sh

@@ -10,6 +10,7 @@ if ! check_command jq; then
 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_JSON_PATH="releases_$OS_NAME.json"
 MANIFEST_URL="$MANIFEST_BASE_URL/$MANIFEST_JSON_PATH"
@@ -48,13 +49,15 @@ download_archive() {
 	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
+		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"
+		rm -r "$EXTRACT_PATH"
 	else
 		tar xf "$archive_local" -C "$2" --strip-components=1
 	fi
@@ -64,15 +67,17 @@ download_archive() {
 
 CACHE_PATH=""
 CACHE_KEY=""
+PUB_CACHE_KEY=""
 PRINT_ONLY=""
 TEST_MODE=false
 ARCH=""
 VERSION=""
 
-while getopts 'tc:k:pa:n:' flag; do
+while getopts 'tc:k:d:pa:n:' flag; do
 	case "$flag" in
 	c) CACHE_PATH="$OPTARG" ;;
 	k) CACHE_KEY="$OPTARG" ;;
+	d) PUB_CACHE_KEY="$OPTARG" ;;
 	p) PRINT_ONLY=true ;;
 	t) TEST_MODE=true ;;
 	a) ARCH="$(echo "$OPTARG" | awk '{print tolower($0)}')" ;;
@@ -81,6 +86,8 @@ while getopts 'tc:k:pa:n:' flag; do
 	esac
 done
 
+[[ -z $ARCH ]] && ARCH="$ARCH_NAME"
+
 ARR_CHANNEL=("${@:$OPTIND:1}")
 CHANNEL="${ARR_CHANNEL[0]}"
 
@@ -89,6 +96,9 @@ CHANNEL="${ARR_CHANNEL[0]}"
 [[ -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:"
+# Here we specifically use `PUB_CACHE` (and not `PUB_CACHE_PATH`), because `PUB_CACHE` is what dart (and flutter) looks for in the environment
+[[ -z $PUB_CACHE ]] && PUB_CACHE="$HOME/.pub-cache"
 
 if [[ "$TEST_MODE" == true ]]; then
 	RELEASE_MANIFEST=$(cat "$(dirname -- "${BASH_SOURCE[0]}")/test/$MANIFEST_JSON_PATH")
@@ -96,8 +106,8 @@ else
 	RELEASE_MANIFEST=$(curl --silent --connect-timeout 15 --retry 5 "$MANIFEST_URL")
 fi
 
-if [[ "$CHANNEL" == "master" ]]; then
-	VERSION_MANIFEST="{\"channel\":\"$CHANNEL\",\"version\":\"$CHANNEL\",\"dart_sdk_arch\":\"$ARCH\",\"hash\":\"$CHANNEL\",\"sha256\":\"$CHANNEL\"}"
+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
@@ -125,6 +135,7 @@ expand_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
@@ -140,6 +151,8 @@ if [[ "$PRINT_ONLY" == true ]]; then
 		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
 
@@ -149,14 +162,20 @@ if [[ "$PRINT_ONLY" == true ]]; then
 		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" ]]; then
-		git clone -b master https://github.com/flutter/flutter.git "$CACHE_PATH"
+	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"
@@ -165,11 +184,11 @@ fi
 
 {
 	echo "FLUTTER_ROOT=$CACHE_PATH"
-	echo "PUB_CACHE=$CACHE_PATH/.pub-cache"
+	echo "PUB_CACHE=$PUB_CACHE"
 } >>"$GITHUB_ENV"
 
 {
 	echo "$CACHE_PATH/bin"
 	echo "$CACHE_PATH/bin/cache/dart-sdk/bin"
-	echo "$CACHE_PATH/.pub-cache/bin"
+	echo "$PUB_CACHE/bin"
 } >>"$GITHUB_PATH"