* readme: update note about yq

* readme: minor updates (semantic line breaks)

* checkout@v4 -> checkout@v6
This commit is contained in:
Bartek Pacia
2026-03-18 15:40:24 +01:00
committed by GitHub
parent 7ff07e9ecd
commit 75b905c640
2 changed files with 35 additions and 42 deletions

View File

@@ -17,7 +17,7 @@ jobs:
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Run shellcheck - name: Run shellcheck
uses: ludeeus/action-shellcheck@master uses: ludeeus/action-shellcheck@master
@@ -42,7 +42,7 @@ jobs:
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- id: flutter-action - id: flutter-action
uses: ./ uses: ./
with: with:
@@ -83,7 +83,7 @@ jobs:
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- uses: ./ - uses: ./
with: with:
channel: stable channel: stable
@@ -103,7 +103,7 @@ jobs:
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- uses: ./ - uses: ./
with: with:
channel: stable channel: stable
@@ -123,7 +123,7 @@ jobs:
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- run: ./setup.sh -t -p -f test/pubspec.yaml | grep '3.3.10' - run: ./setup.sh -t -p -f test/pubspec.yaml | grep '3.3.10'
shell: bash shell: bash
- run: ./setup.sh -t -p | grep 'stable' - run: ./setup.sh -t -p | grep 'stable'
@@ -220,7 +220,7 @@ jobs:
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- run: ./setup.sh -t -p -f test/pubspec.yaml | grep '3.3.10' - run: ./setup.sh -t -p -f test/pubspec.yaml | grep '3.3.10'
shell: bash shell: bash
- run: ./setup.sh -t -p | grep 'stable' - run: ./setup.sh -t -p | grep 'stable'

View File

@@ -1,7 +1,7 @@
# flutter-action # flutter-action
Flutter environment for use in GitHub Actions. It works on Linux, Windows, and Flutter environment for use in GitHub Actions.
macOS. It works on Linux, Windows, and macOS.
Originally created by [Alif Rachmawadi]. Maintained by [Bartek Pacia]. Originally created by [Alif Rachmawadi]. Maintained by [Bartek Pacia].
@@ -14,7 +14,7 @@ The following sections show how to configure this action.
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -30,7 +30,7 @@ This is inspired by [`actions/setup-go`](https://github.com/actions/setup-go).
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -63,16 +63,16 @@ steps:
> [!NOTE] > [!NOTE]
> >
> Using `flutter-version-file` requires [`yq`](https://github.com/mikefarah/yq), > Using `flutter-version-file` requires [`yq`](https://github.com/mikefarah/yq),
> which is not pre-installed in `windows` runners. Fortunately, since version > which is not pre-installed in `windows` runners.
> 2.18.0, this action installs `yq` automatically if `flutter-version-file` > This action installs `yq` automatically if `flutter-version-file` is specified,
> is specified, so no action is required from you. > so no action is required from you.
### Use latest release for particular channel ### Use latest release for particular channel
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -85,7 +85,7 @@ steps:
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -99,7 +99,7 @@ steps:
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -113,7 +113,7 @@ steps:
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -129,7 +129,7 @@ You can get more infomation from [Flutter official docs](https://docs.flutter.de
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
env: env:
FLUTTER_STORAGE_BASE_URL: https://storage.flutter-io.cn FLUTTER_STORAGE_BASE_URL: https://storage.flutter-io.cn
@@ -145,13 +145,12 @@ steps:
This action supports "alternative Flutters" in addition to the official This action supports "alternative Flutters" in addition to the official
[`flutter/flutter`](https://github.com/flutter/flutter), for example: [`flutter/flutter`](https://github.com/flutter/flutter), for example:
- [Flock](https://github.com/join-the-flock/flock.git) - [Flock](https://github.com/join-the-flock/flock.git)
- [a Flutter fork that supports - [a Flutter fork that supports HarmonyOS](https://gitee.com/harmonycommando_flutter/flutter.git)
HarmonyOS](https://gitee.com/harmonycommando_flutter/flutter.git)
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -161,24 +160,18 @@ steps:
- run: flutter --version - 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 ### Apply a patch
Sometimes you find a bug in Flutter and you fix it yourself (you're a Sometimes you find a bug in Flutter and fix it yourself (you're a rockstar!),
rockstar!), and then submit a patch/PR to Flutter repository. However, everyone and then submit a patch/PR to Flutter repository.
knows that code review takes time, but your app needs the fix _now_. However, everyone knows that code review takes time, but your app needs the fix _now_.
You can apply your patch like this: You can apply your patch like this:
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- uses: subosito/flutter-action@v2 - uses: subosito/flutter-action@v2
with: with:
flutter-version: 3.22.2 flutter-version: 3.22.2
@@ -201,7 +194,7 @@ Build **Android** APK and app bundle:
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -224,7 +217,7 @@ jobs:
runs-on: macos-latest runs-on: macos-latest
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -239,7 +232,7 @@ jobs:
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -257,7 +250,7 @@ jobs:
runs-on: windows-latest runs-on: windows-latest
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -273,7 +266,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -296,7 +289,7 @@ jobs:
runs-on: macos-latest runs-on: macos-latest
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -316,7 +309,7 @@ Integration with [`actions/cache`](https://github.com/actions/cache):
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
with: with:
@@ -368,10 +361,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: 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: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
@@ -395,7 +388,7 @@ Use outputs from `flutter-action`:
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
id: flutter-action id: flutter-action
@@ -421,7 +414,7 @@ If you don't need to install Flutter and just want the outputs, you can use the
```yaml ```yaml
steps: steps:
- name: Clone repository - name: Clone repository
- uses: actions/checkout@v4 - uses: actions/checkout@v6
- name: Set up Flutter - name: Set up Flutter
uses: subosito/flutter-action@v2 uses: subosito/flutter-action@v2
id: flutter-action id: flutter-action