Skip to content

Commit fd47628

Browse files
authored
improve readme (#337)
1 parent 799318a commit fd47628

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,61 @@ steps:
122122
- run: flutter --version
123123
```
124124

125-
## Build Target
125+
### Use alternative Flutter repository
126+
127+
This action supports "alternative Flutters" in addition to the official
128+
[`flutter/flutter`](https://github.com/flutter/flutter), for example:
129+
- [Flock](https://github.com/Flutter-Foundation/flutter.git)
130+
- [a Flutter fork that supports
131+
HarmonyOS](https://gitee.com/harmonycommando_flutter/flutter.git)
132+
133+
```yaml
134+
steps:
135+
- name: Clone repository
136+
uses: actions/checkout@v4
137+
- name: Set up Flutter
138+
uses: subosito/flutter-action@v2
139+
with:
140+
channel: master
141+
flutter-version: 3.24.0
142+
git-source: https://github.com/Flutter-Foundation/flutter.git
143+
- run: flutter --version
144+
```
145+
146+
> ![NOTE]
147+
>
148+
> This feature was implemented in
149+
> [#344](https://github.com/subosito/flutter-action/pull/334) and is available
150+
> since v2.18.0.
151+
152+
### Apply a patch
153+
154+
Sometimes you find a bug in Flutter and you fix it yourself (you're a
155+
rockstar!), and then submit a patch/PR to Flutter repository. However, everyone
156+
knows that code review takes time, but your app needs the fix _now_.
157+
158+
You can apply your patch like this:
159+
160+
```yaml
161+
steps:
162+
- name: Clone repository
163+
uses: actions/checkout@v4
164+
- uses: subosito/flutter-action@v2
165+
with:
166+
flutter-version: 3.22.2
167+
channel: stable
168+
- run: |
169+
flutter --version
170+
cd ${{ env.FLUTTER_ROOT }}
171+
curl https://patch-diff.githubusercontent.com/raw/flutter/flutter/pull/137874.patch | git apply
172+
git status
173+
```
174+
175+
> ![NOTE]
176+
>
177+
> This was first discussed in [this issue](https://github.com/subosito/flutter-action/issues/310).
178+
179+
## Build targets
126180

127181
Build **Android** APK and app bundle:
128182

@@ -133,7 +187,7 @@ steps:
133187
- name: Set up Flutter
134188
uses: subosito/flutter-action@v2
135189
with:
136-
flutter-version: 3.19.0
190+
flutter-version: 3.24.0
137191
- run: flutter pub get
138192
- run: flutter test
139193
- run: flutter build apk

0 commit comments

Comments
 (0)