update readme

.github/workflows/workflow.yml

@@ -16,9 +16,9 @@ jobs:
     - name: Print FLUTTER_ROOT
       shell: bash
       run: echo "FLUTTER_ROOT set to $FLUTTER_ROOT"
-    - name: Print PUBCACHE
+    - name: Print PUB_CACHE
       shell: bash
-      run: echo "PUBCACHE set to $PUBCACHE"
+      run: echo "PUB_CACHE set to $PUB_CACHE"
     - name: Run dart --version
       shell: bash
       run: dart --version
@@ -72,3 +72,24 @@ jobs:
     - 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@v2
+    - uses: ./
+      with:
+        channel: stable
+        flutter-version: 2.5.0
+        cache: true
+        cache-key: key-20220113
+        cache-path: ${{ runner.tool_cache }}/flutter/2.5.0-stable
+    - name: Run dart --version
+      shell: bash
+      run: dart --version
+    - name: Run flutter --version
+      shell: bash
+      run: flutter --version

README.md

@@ -1,21 +1,19 @@
 # flutter-action
 
-This action sets up a flutter environment for use in actions. It works on Linux, Windows, and macOS.
+Flutter environment for use in GitHub Actions. It works on Linux, Windows, and macOS.
 
-# Usage
+## Usage
+
+Use specific version and channel:
 
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-java@v2
-  with:
-    distribution: 'zulu'
-    java-version: '11'
 - uses: subosito/flutter-action@v2
   with:
-    flutter-version: '2.0.5'
-- run: flutter pub get
-- run: flutter test
+    flutter-version: '2.8.0'
+    channel: 'stable'
+- run: flutter --version
 ```
 
 Use latest release for particular channel:
@@ -23,16 +21,10 @@ Use latest release for particular channel:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-java@v2
-  with:
-    distribution: 'zulu'
-    java-version: '11'
 - uses: subosito/flutter-action@v2
   with:
     channel: 'stable' # or: 'beta', 'dev' or 'master'
-- run: flutter pub get
-- run: flutter test
-- run: flutter build apk
+- run: flutter --version
 ```
 
 Use latest release for particular version and/or channel:
@@ -40,16 +32,11 @@ Use latest release for particular version and/or channel:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-java@v2
-  with:
-    distribution: 'zulu'
-    java-version: '11'
 - uses: subosito/flutter-action@v2
   with:
     flutter-version: '1.22.x' # or, you can use 1.22
     channel: 'dev'
-- run: flutter pub get
-- run: flutter test
+- run: flutter --version
 ```
 
 Use particular version on any channel:
@@ -57,16 +44,11 @@ Use particular version on any channel:
 ```yaml
 steps:
 - uses: actions/checkout@v2
-- uses: actions/setup-java@v2
-  with:
-    distribution: 'zulu'
-    java-version: '11'
 - uses: subosito/flutter-action@v2
   with:
     flutter-version: '2.x'
     channel: 'any'
-- run: flutter pub get
-- run: flutter test
+- run: flutter --version
 ```
 
 Build Android APK and app bundle:
@@ -80,14 +62,14 @@ steps:
     java-version: '11'
 - uses: subosito/flutter-action@v2
   with:
-    flutter-version: '2.0.5'
+    flutter-version: '2.5.3'
 - run: flutter pub get
 - run: flutter test
 - run: flutter build apk
 - run: flutter build appbundle
 ```
 
-Build for iOS too (macOS only):
+Build for iOS (macOS only):
 
 ```yaml
 jobs:
@@ -95,16 +77,11 @@ jobs:
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/setup-java@v2
-      with:
-        distribution: 'zulu'
-        java-version: '11'
     - uses: subosito/flutter-action@v2
       with:
-        flutter-version: '2.0.5'
+        flutter-version: '2.5.3'
     - run: flutter pub get
     - run: flutter test
-    - run: flutter build apk
     - run: flutter build ios --release --no-codesign
 ```
 
@@ -115,7 +92,7 @@ steps:
 - uses: actions/checkout@v2
 - uses: subosito/flutter-action@v2
   with:
-    flutter-version: '2.0.5'
+    flutter-version: '2.5.3'
 - run: flutter pub get
 - run: flutter test
 - run: flutter build web
@@ -124,37 +101,62 @@ steps:
 Build for Windows:
 
 ```yaml
-  windows:
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: subosito/flutter-action@v2
-        with:
-          channel: beta
-      - run: flutter config --enable-windows-desktop
-      - run: flutter build windows
+jobs:
+ build:
+   runs-on: windows-latest
+   steps:
+     - uses: actions/checkout@v2
+     - uses: subosito/flutter-action@v2
+       with:
+         channel: beta
+     - run: flutter config --enable-windows-desktop
+     - run: flutter build windows
 ```
 
-Matrix Testing:
+Build for Linux desktop:
 
 ```yaml
 jobs:
-  test:
-    name: Test on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-java@v2
-        with:
-          distribution: 'zulu'
-          java-version: '11'
-      - uses: subosito/flutter-action@v2
-        with:
-          flutter-version: '1.20.2'
-          channel: 'beta'
-      - run: dart --version
-      - run: flutter --version
+ build:
+   runs-on: ubuntu-latest
+   steps:
+     - uses: actions/checkout@v2
+     - uses: subosito/flutter-action@v2
+       with:
+         channel: beta
+     - 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:
+
+```yaml
+jobs:
+ build:
+   runs-on: macos-latest
+   steps:
+     - uses: actions/checkout@v2
+     - uses: subosito/flutter-action@v2
+       with:
+         channel: beta
+     - run: flutter config --enable-macos-desktop
+     - run: flutter build macos
+```
+
+Integration with `actions/cache`:
+
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: subosito/flutter-action@v2
+  with:
+    flutter-version: 2.5.0
+    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
+- run: flutter --version
 ```

action.yml

@@ -12,8 +12,24 @@ inputs:
     description: 'The Flutter build release channel'
     required: false
     default: 'stable'
+  cache:
+    description: 'Cache the Flutter SDK'
+    required: false
+  cache-key:
+    description: 'Identifier for the Flutter SDK cache'
+    required: false
+    default: 'flutter'
+  cache-path:
+    description: 'Flutter SDK cache path'
+    required: false
+    default: ${{ runner.tool_cache }}/flutter
 runs:
   using: 'composite'
   steps:
-    - run: $GITHUB_ACTION_PATH/setup.sh ${{ inputs.channel }} ${{ inputs.flutter-version }}
+    - if: ${{ inputs.cache == 'true' }}
+      uses: actions/cache@v2
+      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 }}
       shell: bash

setup.sh

@@ -53,42 +53,64 @@ download_archive() {
   curl --connect-timeout 15 --retry 5 $archive_url >$archive_local
 
   if [[ $archive_name == *zip ]]; then
-    unzip -o "$archive_local" -d "$2"
+    unzip -o "$archive_local" -d "$HOME"
+    shopt -s dotglob
+    mv ${HOME}/flutter/* "$2"
+    shopt -u dotglob
   else
-    tar xf "$archive_local" -C "$2"
+    tar xf "$archive_local" -C "$2" --strip-components=1
   fi
 
   rm $archive_local
 }
 
-CHANNEL="$1"
-VERSION="$2"
-
-if [[ $CHANNEL == master ]]; then
-  git clone -b master https://github.com/flutter/flutter.git "$RUNNER_TOOL_CACHE/flutter"
-else
-  VERSION_MANIFEST=$(get_version_manifest $CHANNEL $VERSION)
-
-  if [[ $VERSION_MANIFEST == null ]]; then
-    echo "Unable to determine Flutter version for $CHANNEL $VERSION"
-    exit 1
+transform_path() {
+  if [[ $OS_NAME == windows ]]; then
+    echo $1 | sed -e 's/^\///' -e 's/\//\\/g'
+  else
+    echo $1
   fi
+}
 
-  ARCHIVE_PATH=$(echo $VERSION_MANIFEST | jq -r '.archive')
-  download_archive "$ARCHIVE_PATH" "$RUNNER_TOOL_CACHE"
-fi
+SDK_CACHE=""
+
+while getopts 'c:' flag; do
+  case "${flag}" in
+  c) SDK_CACHE="$(transform_path $OPTARG)" ;;
+  ?) exit 2 ;;
+  esac
+done
+
+CHANNEL="${@:$OPTIND:1}"
+VERSION="${@:$OPTIND+1:1}"
 
 if [[ $OS_NAME == windows ]]; then
-  FLUTTER_ROOT="${RUNNER_TOOL_CACHE}\\flutter"
-  PUBCACHE="${USERPROFILE}\\.pub-cache"
+  PUB_CACHE="${USERPROFILE}\\.pub-cache"
 else
-  FLUTTER_ROOT="${RUNNER_TOOL_CACHE}/flutter"
-  PUBCACHE="${HOME}/.pub-cache"
+  PUB_CACHE="${HOME}/.pub-cache"
 fi
 
-echo "FLUTTER_ROOT=${FLUTTER_ROOT}" >>$GITHUB_ENV
-echo "PUB_CACHE=${PUBCACHE}" >>$GITHUB_ENV
+mkdir -p "$SDK_CACHE"
 
-echo "${FLUTTER_ROOT}/bin" >>$GITHUB_PATH
-echo "${FLUTTER_ROOT}/bin/cache/dart-sdk/bin" >>$GITHUB_PATH
-echo "${PUBCACHE}/bin" >>$GITHUB_PATH
+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 $VERSION"
+      exit 1
+    fi
+
+    ARCHIVE_PATH=$(echo $VERSION_MANIFEST | jq -r '.archive')
+    download_archive "$ARCHIVE_PATH" "$SDK_CACHE"
+  fi
+fi
+
+echo "FLUTTER_ROOT=${SDK_CACHE}" >>$GITHUB_ENV
+echo "PUB_CACHE=${PUB_CACHE}" >>$GITHUB_ENV
+
+echo "${SDK_CACHE}/bin" >>$GITHUB_PATH
+echo "${SDK_CACHE}/bin/cache/dart-sdk/bin" >>$GITHUB_PATH
+echo "${PUB_CACHE}/bin" >>$GITHUB_PATH