mirror of
https://github.com/subosito/flutter-action.git
synced 2024-08-16 10:19:50 +02:00
format README
This commit is contained in:
Bartek Pacia
parent
46719f5374
commit
e2c456ecd7
1 changed files with 134 additions and 108 deletions
130
README.md
130
README.md
|
|
@ -1,6 +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.
|
||||
|
||||
The following sections show how to configure this action.
|
||||
|
||||
|
|
@ -10,11 +11,13 @@ Use specific version and channel:
|
|||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
flutter-version: '3.16.9'
|
||||
channel: 'stable'
|
||||
flutter-version: 3.19.0
|
||||
channel: stable
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
|
|
@ -22,10 +25,12 @@ Use latest release for particular channel:
|
|||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: 'stable' # or: 'beta', 'dev', 'master' (or 'main')
|
||||
channel: stable # or: beta, master (or main)
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
|
|
@ -33,11 +38,13 @@ Use latest release for particular version and/or channel:
|
|||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
flutter-version: '1.22.x'
|
||||
channel: 'dev'
|
||||
flutter-version: 1.22.x
|
||||
channel: dev
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
|
|
@ -46,10 +53,11 @@ Use particular version on any channel:
|
|||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
flutter-version: '3.x'
|
||||
channel: 'any'
|
||||
flutter-version: "3.x"
|
||||
channel: any
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
|
|
@ -58,10 +66,11 @@ Use particular git reference on master channel:
|
|||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
flutter-version: '5b12b74' # tag, commit or branch
|
||||
channel: 'master'
|
||||
flutter-version: 5b12b74 # tag, commit or branch
|
||||
channel: master
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
|
|
@ -71,27 +80,31 @@ Build **Android** APK and app bundle:
|
|||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
flutter-version: '3.16.9'
|
||||
flutter-version: 3.19.0
|
||||
- run: flutter pub get
|
||||
- run: flutter test
|
||||
- run: flutter build apk
|
||||
- run: flutter build appbundle
|
||||
```
|
||||
|
||||
Build for **iOS** (macOS only):
|
||||
Build for **iOS** (macOS runners only):
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
build:
|
||||
main:
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: 'stable'
|
||||
channel: stable
|
||||
- run: flutter pub get
|
||||
- run: flutter test
|
||||
- run: flutter build ios --release --no-codesign
|
||||
|
|
@ -101,10 +114,12 @@ Build for the **web**:
|
|||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: 'stable'
|
||||
channel: "stable"
|
||||
- run: flutter pub get
|
||||
- run: flutter test
|
||||
- run: flutter build web
|
||||
|
|
@ -114,13 +129,15 @@ Build for **Windows**:
|
|||
|
||||
```yaml
|
||||
jobs:
|
||||
build:
|
||||
main:
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: 'stable'
|
||||
channel: stable
|
||||
- run: flutter build windows
|
||||
```
|
||||
|
||||
|
|
@ -128,13 +145,15 @@ Build for **Linux** desktop:
|
|||
|
||||
```yaml
|
||||
jobs:
|
||||
build:
|
||||
main:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: 'stable'
|
||||
channel: stable
|
||||
- run: |
|
||||
sudo apt-get update -y
|
||||
sudo apt-get install -y ninja-build libgtk-3-dev
|
||||
|
|
@ -145,36 +164,41 @@ Build for **macOS** desktop:
|
|||
|
||||
```yaml
|
||||
jobs:
|
||||
build:
|
||||
main:
|
||||
runs-on: macos-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: 'stable'
|
||||
channel: "stable"
|
||||
- run: flutter build macos
|
||||
```
|
||||
|
||||
## Caching
|
||||
|
||||
Integration with `actions/cache`:
|
||||
Integration with [`actions/cache`](https://github.com/actions/cache):
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: subosito/flutter-action@v2
|
||||
- name: Clone repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
with:
|
||||
channel: 'stable'
|
||||
channel: stable
|
||||
cache: true
|
||||
# optional parameters follow
|
||||
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
|
||||
pub-cache-path: '${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:' # optional, change this to specify the cache path
|
||||
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
|
||||
pub-cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:" # optional, change this to specify the cache path
|
||||
- run: flutter --version
|
||||
```
|
||||
|
||||
Note: `cache-key`, `pub-cache-key`, and `cache-path` has support for several dynamic values:
|
||||
Note: `cache-key`, `pub-cache-key`, and `cache-path` have support for several
|
||||
dynamic values:
|
||||
|
||||
- `:os:`
|
||||
- `:channel:`
|
||||
|
|
@ -187,11 +211,13 @@ Use outputs from `flutter-action`:
|
|||
|
||||
```yaml
|
||||
steps:
|
||||
- name: Clone repository
|
||||
- uses: actions/checkout@v4
|
||||
- id: flutter-action
|
||||
- name: Set up Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
id: flutter-action
|
||||
with:
|
||||
channel: 'stable'
|
||||
channel: stable
|
||||
- run: |
|
||||
echo CACHE-PATH=${{ steps.flutter-action.outputs.CACHE-PATH }}
|
||||
echo CACHE-KEY=${{ steps.flutter-action.outputs.CACHE-KEY }}
|
||||
|
|
|
|||
Loading…
Reference in a new issue