Add input to automatically setup Flutter

.github/test.yaml → .github/workflows/test.yaml

@@ -26,8 +26,8 @@ jobs:
       - run: echo ${{ env.FLUTTER_VERSION }}
       - run: echo ${{ env.FLUTTER_CHANNEL }}
 
-  test-setup:
-    name: Setup
+  test-setup-flutter:
+    name: Setup Flutter
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -36,5 +36,5 @@ jobs:
         uses: ./
         with:
           path: test/.fvmrc
-          setup-flutter: true
+          setup: true
       - run: flutter --version

README.md

@@ -4,7 +4,24 @@ can then be used to configure the [flutter-action](https://github.com/subosito/f
 
 ## Usage
 
+All the sample options below can be combined with each other.
+
 ### Basic usage
+
+The configuration will parse the FVM configuration and use subosito/flutter-action to install & cache the configured Flutter version.
+
+```yaml
+    steps:
+      - uses: actions/checkout@v4
+      - uses: kuhnroyal/flutter-fvm-config-action@v2
+        with:
+          # The setup flag enables installation of the Flutter SDK, will default to true in the next major version (v3)
+          setup: true
+          # The cache flag enables caching of the Flutter SDK, default is true - if setup is true
+          cache: true
+```
+
+### Basic usage with manual configuration
 ```yaml
     steps:
       - uses: actions/checkout@v4

action.yaml

@@ -9,10 +9,14 @@ inputs:
     description: 'Flavor to use'
     required: false
     default: ''
-  setup-flutter:
-    description: 'Setup Flutter (default: false)'
+  setup:
+    description: 'Setup Flutter via "subosito/flutter-action"? (default: false)'
     required: false
     default: 'false'
+  cache:
+    description: 'Cache Flutter via "subosito/flutter-action"? (default: true - if setup is true)'
+    required: false
+    default: 'true'
 outputs:
   FLUTTER_VERSION:
     description: 'The version of Flutter specified in the fvm configuration file'
@@ -23,17 +27,19 @@ outputs:
 runs:
   using: 'composite'
   steps:
-    - uses: ./config-action
+    - name: Parse configuration
+      uses: ./config-action
       id: config-action
       with:
         path: ${{ inputs.path }}
         flavor: ${{ inputs.flavor }}
-    - uses: subosito/flutter-action@v2
-      if: inputs.setup-flutter == 'true'
+    - name: Setup Flutter
+      uses: subosito/flutter-action@v2
+      if: inputs.setup == 'true'
       with:
-        cache: true
+        cache: ${{ inputs.cache }}
         flutter-version: ${{ steps.config-action.outputs.FLUTTER_VERSION }}
         channel: ${{ steps.config-action.outputs.FLUTTER_CHANNEL }}
 branding:
   icon: 'maximize'
-  color: 'blue'
+  color: 'blue'