Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1a449444c3 | ||
|
|
4efee115f1 | ||
|
|
d97c38e97d | ||
|
|
75b905c640 | ||
|
|
7ff07e9ecd | ||
|
|
6622f58c44 |
41
.github/workflows/workflow.yaml
vendored
41
.github/workflows/workflow.yaml
vendored
@@ -17,7 +17,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Run shellcheck
|
||||
uses: ludeeus/action-shellcheck@master
|
||||
|
||||
@@ -42,7 +42,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- id: flutter-action
|
||||
uses: ./
|
||||
with:
|
||||
@@ -83,7 +83,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- uses: ./
|
||||
with:
|
||||
channel: stable
|
||||
@@ -103,7 +103,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- uses: ./
|
||||
with:
|
||||
channel: stable
|
||||
@@ -115,6 +115,35 @@ jobs:
|
||||
run: flutter --version | grep '3.3.10'
|
||||
shell: bash
|
||||
|
||||
test_master_version:
|
||||
runs-on: ${{ matrix.operating-system }}
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
operating-system: [ubuntu-latest, macos-latest]
|
||||
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v6
|
||||
- id: flutter-action
|
||||
uses: ./
|
||||
with:
|
||||
channel: master
|
||||
flutter-version: e6ed6e9e16782a24a912e79d3100c496600aae5b # some commit made on 18/03/2026
|
||||
- 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 }}
|
||||
echo VERSION=${{ steps.flutter-action.outputs.VERSION }}
|
||||
echo ARCHITECTURE=${{ steps.flutter-action.outputs.ARCHITECTURE }}
|
||||
shell: bash
|
||||
- run: flutter --version
|
||||
shell: bash
|
||||
|
||||
test_print_output_x64:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
@@ -123,7 +152,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- run: ./setup.sh -t -p -f test/pubspec.yaml | grep '3.3.10'
|
||||
shell: bash
|
||||
- run: ./setup.sh -t -p | grep 'stable'
|
||||
@@ -220,7 +249,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- run: ./setup.sh -t -p -f test/pubspec.yaml | grep '3.3.10'
|
||||
shell: bash
|
||||
- run: ./setup.sh -t -p | grep 'stable'
|
||||
|
||||
92
README.md
92
README.md
@@ -1,7 +1,7 @@
|
||||
# flutter-action
|
||||
|
||||
Flutter environment for use in GitHub Actions. It works on Linux, Windows, and
|
||||
macOS.
|
||||
Flutter environment for use in GitHub Actions.
|
||||
It works on Linux, Windows, and macOS.
|
||||
|
||||
Originally created by [Alif Rachmawadi]. Maintained by [Bartek Pacia].
|
||||
|
||||
@@ -14,7 +14,7 @@ The following sections show how to configure this action.
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -23,19 +23,19 @@ steps:
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
### Use version from pubspec.yaml
|
||||
### Use version from pubspec.yaml or FVM config
|
||||
|
||||
This is inspired by [`actions/setup-go`](https://github.com/actions/setup-go).
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: stable
|
||||
flutter-version-file: pubspec.yaml # path to pubspec.yaml
|
||||
flutter-version-file: pubspec.yaml # path to pubspec.yaml or .fvmrc or .fvm/fvm_config.json
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
@@ -63,16 +63,16 @@ steps:
|
||||
> [!NOTE]
|
||||
>
|
||||
> Using `flutter-version-file` requires [`yq`](https://github.com/mikefarah/yq),
|
||||
> which is not pre-installed in `windows` runners. Fortunately, since version
|
||||
> 2.18.0, this action installs `yq` automatically if `flutter-version-file`
|
||||
> is specified, so no action is required from you.
|
||||
> which is not pre-installed in `windows` runners.
|
||||
> This action installs `yq` automatically if `flutter-version-file` is specified,
|
||||
> so no action is required from you.
|
||||
|
||||
### Use latest release for particular channel
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -85,7 +85,7 @@ steps:
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -99,7 +99,7 @@ steps:
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -113,7 +113,7 @@ steps:
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -129,7 +129,7 @@ You can get more infomation from [Flutter official docs](https://docs.flutter.de
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
env:
|
||||
FLUTTER_STORAGE_BASE_URL: https://storage.flutter-io.cn
|
||||
@@ -145,13 +145,12 @@ steps:
|
||||
This action supports "alternative Flutters" in addition to the official
|
||||
[`flutter/flutter`](https://github.com/flutter/flutter), for example:
|
||||
- [Flock](https://github.com/join-the-flock/flock.git)
|
||||
- [a Flutter fork that supports
|
||||
HarmonyOS](https://gitee.com/harmonycommando_flutter/flutter.git)
|
||||
- [a Flutter fork that supports HarmonyOS](https://gitee.com/harmonycommando_flutter/flutter.git)
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -161,24 +160,18 @@ steps:
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> This feature was implemented in
|
||||
> [#344](https://github.com/subosito/flutter-action/pull/334) and is available
|
||||
> since v2.18.0.
|
||||
|
||||
### Apply a patch
|
||||
|
||||
Sometimes you find a bug in Flutter and you fix it yourself (you're a
|
||||
rockstar!), and then submit a patch/PR to Flutter repository. However, everyone
|
||||
knows that code review takes time, but your app needs the fix _now_.
|
||||
Sometimes you find a bug in Flutter and fix it yourself (you're a rockstar!),
|
||||
and then submit a patch/PR to Flutter repository.
|
||||
However, everyone knows that code review takes time, but your app needs the fix _now_.
|
||||
|
||||
You can apply your patch like this:
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- uses: subosito/flutter-action@v2
|
||||
with:
|
||||
flutter-version: 3.22.2
|
||||
@@ -201,7 +194,7 @@ Build **Android** APK and app bundle:
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -224,7 +217,7 @@ jobs:
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -239,7 +232,7 @@ jobs:
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -257,7 +250,7 @@ jobs:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -273,7 +266,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -296,7 +289,7 @@ jobs:
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
@@ -309,20 +302,21 @@ jobs:
|
||||
Integration with [`actions/cache`](https://github.com/actions/cache):
|
||||
|
||||
> [!IMPORTANT]
|
||||
> `subosito/flutter-action` now uses `actions/cache@v5` internally. If you use
|
||||
> self-hosted runners, make sure they are updated to Actions Runner
|
||||
> `2.327.1` or newer before enabling cache support.
|
||||
> `subosito/flutter-action` now uses `actions/cache@v5` internally.
|
||||
> If you use self-hosted runners, make sure they are updated
|
||||
> to Actions Runner `2.327.1` or newer before enabling cache support.
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: stable
|
||||
cache: true
|
||||
# optional parameters follow
|
||||
pub-cache: true # optional, defaults to empty (falls back to cache value for backward compatibility)
|
||||
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
|
||||
pub-cache-key: "flutter-pub-:os:-:channel:-:version:-:arch:-:hash:" # optional, change this to force refresh cache of dart pub get dependencies
|
||||
@@ -330,6 +324,22 @@ steps:
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> **The `cache` and `pub-cache` inputs are independent and control different caches:**
|
||||
> - `cache: true/false` - controls whether to cache the Flutter SDK installation
|
||||
> - `pub-cache: true/false` - controls whether to cache the pub dependencies
|
||||
>
|
||||
> **Backward Compatibility:** When `pub-cache` is not specified (empty), it falls back to the `cache` value.
|
||||
> This means existing workflows with `cache: true` automatically cache both Flutter SDK and pub dependencies.
|
||||
>
|
||||
> You can use them in any combination:
|
||||
> - Both enabled: `cache: true` (`pub-cache` defaults to true for backward compatibility)
|
||||
> - Both enabled explicitly: `cache: true` and `pub-cache: true`
|
||||
> - Only Flutter SDK: `cache: true` and `pub-cache: false`
|
||||
> - Only pub dependencies: `cache: false` and `pub-cache: true` for self-hosted runners
|
||||
> - Neither: `cache: false` and `pub-cache: false` (or omit both)
|
||||
|
||||
Note: `cache-key`, `pub-cache-key`, and `cache-path` have support for several
|
||||
dynamic values:
|
||||
|
||||
@@ -350,10 +360,10 @@ dynamic values:
|
||||
|
||||
Example usage (inspired by [actions/cache@v5](https://github.com/actions/cache/blob/v5/README.md#skipping-steps-based-on-cache-hit) and [#346](https://github.com/subosito/flutter-action/pull/346)) to skip `melos bootstrap` if there was a pub cache hit:
|
||||
|
||||
```
|
||||
```yaml
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
@@ -377,7 +387,7 @@ Use outputs from `flutter-action`:
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
id: flutter-action
|
||||
@@ -403,7 +413,7 @@ If you don't need to install Flutter and just want the outputs, you can use the
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v6
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
id: flutter-action
|
||||
|
||||
10
action.yaml
10
action.yaml
@@ -15,7 +15,7 @@ inputs:
|
||||
required: false
|
||||
default: ""
|
||||
flutter-version-file:
|
||||
description: The pubspec.yaml file with exact Flutter version defined
|
||||
description: The pubspec.yaml or FVM config file with exact Flutter version defined
|
||||
required: false
|
||||
default: ""
|
||||
architecture:
|
||||
@@ -34,6 +34,10 @@ inputs:
|
||||
description: Flutter SDK cache path
|
||||
required: false
|
||||
default: ""
|
||||
pub-cache:
|
||||
description: Cache the Dart pub dependencies
|
||||
required: false
|
||||
default: ""
|
||||
pub-cache-key:
|
||||
description: Identifier for the Dart .pub-cache cache
|
||||
required: false
|
||||
@@ -91,7 +95,7 @@ runs:
|
||||
# It's not preinstalled on Windows runners.
|
||||
# See https://github.com/actions/runner-images/issues/7443#issuecomment-1514597691
|
||||
- name: Make yq tool available on Windows runners
|
||||
if: runner.os == 'Windows' && inputs.flutter-version-file != ''
|
||||
if: runner.os == 'Windows' && inputs.flutter-version-file != '' && !endsWith(inputs.flutter-version-file, '.fvmrc') && !endsWith(inputs.flutter-version-file, 'fvm_config.json')
|
||||
run: choco install yq
|
||||
shell: bash
|
||||
|
||||
@@ -125,7 +129,7 @@ runs:
|
||||
- name: Cache pub dependencies
|
||||
uses: actions/cache@v5
|
||||
id: cache-pub
|
||||
if: ${{ inputs.cache == 'true' }}
|
||||
if: ${{ (inputs.pub-cache == '' && inputs.cache == 'true') || inputs.pub-cache == 'true' }}
|
||||
with:
|
||||
path: ${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}
|
||||
key: ${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}-${{ hashFiles('**/pubspec.lock') }}
|
||||
|
||||
51
setup.sh
51
setup.sh
@@ -51,18 +51,10 @@ download_archive() {
|
||||
|
||||
case "$archive_name" in
|
||||
*.zip)
|
||||
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 "$EXTRACT_PATH"/flutter "$2"
|
||||
rm -r "$EXTRACT_PATH"
|
||||
unzip -q -o "$archive_local" -d "$2"
|
||||
;;
|
||||
*)
|
||||
tar xf "$archive_local" -C "$2" --strip-components=1
|
||||
tar xf "$archive_local" -C "$2"
|
||||
;;
|
||||
esac
|
||||
|
||||
@@ -92,9 +84,11 @@ while getopts 'tc:k:d:l:pa:n:f:g:' flag; do
|
||||
n) VERSION="$OPTARG" ;;
|
||||
f)
|
||||
VERSION_FILE="$OPTARG"
|
||||
if [ -n "$VERSION_FILE" ] && ! check_command yq; then
|
||||
echo "yq not found. Install it from https://mikefarah.gitbook.io/yq"
|
||||
exit 1
|
||||
if [ -n "$VERSION_FILE" ]; then
|
||||
if [[ "$VERSION_FILE" != *".fvmrc" ]] && [[ "$VERSION_FILE" != *"fvm_config.json" ]] && ! check_command yq; then
|
||||
echo "yq not found. Install it from https://mikefarah.gitbook.io/yq"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
;;
|
||||
g) GIT_SOURCE="$OPTARG" ;;
|
||||
@@ -110,11 +104,24 @@ if [ -n "$VERSION_FILE" ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
VERSION="$(yq eval '.environment.flutter' "$VERSION_FILE")"
|
||||
if [[ "$VERSION_FILE" == *".fvmrc" ]]; then
|
||||
VERSION="$(jq -r '.flutter' "$VERSION_FILE")"
|
||||
elif [[ "$VERSION_FILE" == *"fvm_config.json" ]]; then
|
||||
VERSION="$(jq -r '.flutterSdkVersion // .flutter' "$VERSION_FILE")"
|
||||
else
|
||||
VERSION="$(yq eval '.environment.flutter' "$VERSION_FILE")"
|
||||
fi
|
||||
|
||||
if [[ "$VERSION" == "stable" ]] || [[ "$VERSION" == "beta" ]] || [[ "$VERSION" == "master" ]] || [[ "$VERSION" == "main" ]]; then
|
||||
CHANNEL="$VERSION"
|
||||
VERSION="any"
|
||||
fi
|
||||
fi
|
||||
|
||||
ARR_CHANNEL=("${@:$OPTIND:1}")
|
||||
CHANNEL="${ARR_CHANNEL[0]:-}"
|
||||
if [ -z "${CHANNEL:-}" ]; then
|
||||
CHANNEL="${ARR_CHANNEL[0]:-}"
|
||||
fi
|
||||
|
||||
[ -z "$CHANNEL" ] && CHANNEL=stable
|
||||
[ -z "$VERSION" ] && VERSION=any
|
||||
@@ -215,12 +222,12 @@ if [ "$PRINT_ONLY" = true ]; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [ ! -x "$CACHE_PATH/bin/flutter" ]; then
|
||||
if [ ! -x "$CACHE_PATH/flutter/bin/flutter" ]; then
|
||||
if [ "$CHANNEL" = "master" ] || [ "$CHANNEL" = "main" ]; then
|
||||
git clone -b "$CHANNEL" "$GIT_SOURCE" "$CACHE_PATH"
|
||||
git clone -b "$CHANNEL" "$GIT_SOURCE" "$CACHE_PATH/flutter"
|
||||
if [ "$VERSION" != "any" ]; then
|
||||
git config --global --add safe.directory "$CACHE_PATH"
|
||||
(cd "$CACHE_PATH" && git checkout "$VERSION")
|
||||
git config --global --add safe.directory "$CACHE_PATH/flutter"
|
||||
(cd "$CACHE_PATH/flutter" && git checkout "$VERSION")
|
||||
fi
|
||||
else
|
||||
archive_url=$(echo "$VERSION_MANIFEST" | jq -r '.archive')
|
||||
@@ -229,12 +236,12 @@ if [ ! -x "$CACHE_PATH/bin/flutter" ]; then
|
||||
fi
|
||||
|
||||
{
|
||||
echo "FLUTTER_ROOT=$CACHE_PATH"
|
||||
echo "FLUTTER_ROOT=$CACHE_PATH/flutter"
|
||||
echo "PUB_CACHE=$PUB_CACHE"
|
||||
} >>"${GITHUB_ENV:-/dev/null}"
|
||||
|
||||
{
|
||||
echo "$CACHE_PATH/bin"
|
||||
echo "$CACHE_PATH/bin/cache/dart-sdk/bin"
|
||||
echo "$CACHE_PATH/flutter/bin"
|
||||
echo "$CACHE_PATH/flutter/bin/cache/dart-sdk/bin"
|
||||
echo "$PUB_CACHE/bin"
|
||||
} >>"${GITHUB_PATH:-/dev/null}"
|
||||
|
||||
Reference in New Issue
Block a user