actions/cache integration

.github/workflows/workflow.yml

@@ -72,3 +72,23 @@ 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-20220110
+    - name: Run dart --version
+      shell: bash
+      run: dart --version
+    - name: Run flutter --version
+      shell: bash
+      run: flutter --version

README.md

@@ -1,8 +1,8 @@
 # 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:
 
@@ -113,22 +113,49 @@ jobs:
      - 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: 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:
+    channel: stable
+    flutter-version: 2.5.0
+    cache: true
+    cache-key: flutter # optional, change this to force refresh cache
+- run: flutter --version
 ```

action.yml

@@ -12,8 +12,20 @@ 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'
 runs:
   using: 'composite'
   steps:
+    - if: ${{ inputs.cache == 'true' }}
+      uses: actions/cache@v2
+      with:
+        path: ${{ runner.tool_cache }}/flutter
+        key: ${{ inputs.cache-key }}-${{ inputs.channel }}-${{ inputs.flutter-version }}
     - run: $GITHUB_ACTION_PATH/setup.sh ${{ inputs.channel }} ${{ inputs.flutter-version }}
       shell: bash

setup.sh

@@ -64,20 +64,6 @@ download_archive() {
 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
-  fi
-
-  ARCHIVE_PATH=$(echo $VERSION_MANIFEST | jq -r '.archive')
-  download_archive "$ARCHIVE_PATH" "$RUNNER_TOOL_CACHE"
-fi
-
 if [[ $OS_NAME == windows ]]; then
   FLUTTER_ROOT="${RUNNER_TOOL_CACHE}\\flutter"
   PUB_CACHE="${USERPROFILE}\\.pub-cache"
@@ -86,6 +72,22 @@ else
   PUB_CACHE="${HOME}/.pub-cache"
 fi
 
+if [[ ! -x "${FLUTTER_ROOT}/bin/flutter" ]]; then
+  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
+    fi
+
+    ARCHIVE_PATH=$(echo $VERSION_MANIFEST | jq -r '.archive')
+    download_archive "$ARCHIVE_PATH" "$RUNNER_TOOL_CACHE"
+  fi
+fi
+
 echo "FLUTTER_ROOT=${FLUTTER_ROOT}" >>$GITHUB_ENV
 echo "PUB_CACHE=${PUB_CACHE}" >>$GITHUB_ENV