actions/flutter
1
0
Fork 0
mirror of https://github.com/subosito/flutter-action.git synced 2024-08-16 10:19:50 +02:00
Code Releases Activity

format README

Browse source
This commit is contained in:
Bartek Pacia 2024-03-31 19:30:30 +02:00
parent 46719f5374
commit e2c456ecd7
No known key found for this signature in database
1 changed files with 134 additions and 108 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

242
README.md
View file

@ -1,6 +1,7 @@
# flutter-action # 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. The following sections show how to configure this action.
@ -10,59 +11,67 @@ Use specific version and channel:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
flutter-version: '3.16.9' uses: subosito/flutter-action@v2
channel: 'stable' with:
- run: flutter --version flutter-version: 3.19.0
channel: stable
- run: flutter --version
``` ```
Use latest release for particular channel: Use latest release for particular channel:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
channel: 'stable' # or: 'beta', 'dev', 'master' (or 'main') uses: subosito/flutter-action@v2
- run: flutter --version with:
channel: stable # or: beta, master (or main)
- run: flutter --version
``` ```
Use latest release for particular version and/or channel: Use latest release for particular version and/or channel:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
flutter-version: '1.22.x' uses: subosito/flutter-action@v2
channel: 'dev' with:
- run: flutter --version flutter-version: 1.22.x
channel: dev
- run: flutter --version
``` ```
Use particular version on any channel: Use particular version on any channel:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: subosito/flutter-action@v2 - name: Set up Flutter
with: uses: subosito/flutter-action@v2
flutter-version: '3.x' with:
channel: 'any' flutter-version: "3.x"
- run: flutter --version channel: any
- run: flutter --version
``` ```
Use particular git reference on master channel: Use particular git reference on master channel:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: subosito/flutter-action@v2 - name: Set up Flutter
with: uses: subosito/flutter-action@v2
flutter-version: '5b12b74' # tag, commit or branch with:
channel: 'master' flutter-version: 5b12b74 # tag, commit or branch
- run: flutter --version channel: master
- run: flutter --version
``` ```
## Build Target ## Build Target
@ -71,110 +80,125 @@ Build **Android** APK and app bundle:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
flutter-version: '3.16.9' uses: subosito/flutter-action@v2
- run: flutter pub get with:
- run: flutter test flutter-version: 3.19.0
- run: flutter build apk - run: flutter pub get
- run: flutter build appbundle - run: flutter test
- run: flutter build apk
- run: flutter build appbundle
``` ```
Build for **iOS** (macOS only): Build for **iOS** (macOS runners only):
```yaml ```yaml
jobs: jobs:
build: main:
runs-on: macos-latest runs-on: macos-latest
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
channel: 'stable' uses: subosito/flutter-action@v2
- run: flutter pub get with:
- run: flutter test channel: stable
- run: flutter build ios --release --no-codesign - run: flutter pub get
- run: flutter test
- run: flutter build ios --release --no-codesign
``` ```
Build for the **web**: Build for the **web**:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
channel: 'stable' uses: subosito/flutter-action@v2
- run: flutter pub get with:
- run: flutter test channel: "stable"
- run: flutter build web - run: flutter pub get
- run: flutter test
- run: flutter build web
``` ```
Build for **Windows**: Build for **Windows**:
```yaml ```yaml
jobs: jobs:
build: main:
runs-on: windows-latest runs-on: windows-latest
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
channel: 'stable' uses: subosito/flutter-action@v2
- run: flutter build windows with:
channel: stable
- run: flutter build windows
``` ```
Build for **Linux** desktop: Build for **Linux** desktop:
```yaml ```yaml
jobs: jobs:
build: main:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
channel: 'stable' uses: subosito/flutter-action@v2
- run: | with:
sudo apt-get update -y channel: stable
sudo apt-get install -y ninja-build libgtk-3-dev - run: |
- run: flutter build linux sudo apt-get update -y
sudo apt-get install -y ninja-build libgtk-3-dev
- run: flutter build linux
``` ```
Build for **macOS** desktop: Build for **macOS** desktop:
```yaml ```yaml
jobs: jobs:
build: main:
runs-on: macos-latest runs-on: macos-latest
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
channel: 'stable' uses: subosito/flutter-action@v2
- run: flutter build macos with:
channel: "stable"
- run: flutter build macos
``` ```
## Caching ## Caching
Integration with `actions/cache`: Integration with [`actions/cache`](https://github.com/actions/cache):
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- uses: subosito/flutter-action@v2 uses: actions/checkout@v4
with: - name: Set up Flutter
channel: 'stable' uses: subosito/flutter-action@v2
cache: true with:
# optional parameters follow channel: stable
cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:' # optional, change this to force refresh cache cache: true
cache-path: '${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:' # optional, change this to specify the cache path # optional parameters follow
pub-cache-key: 'flutter-pub:os:-:channel:-:version:-:arch:-:hash:' # optional, change this to force refresh cache of dart pub get dependencies cache-key: "flutter-:os:-:channel:-:version:-:arch:-:hash:" # optional, change this to force refresh cache
pub-cache-path: '${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:' # optional, change this to specify the cache path cache-path: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:" # optional, change this to specify the cache path
- run: flutter --version 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:` - `:os:`
- `:channel:` - `:channel:`
@ -187,18 +211,20 @@ Use outputs from `flutter-action`:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - name: Clone repository
- id: flutter-action - uses: actions/checkout@v4
uses: subosito/flutter-action@v2 - name: Set up Flutter
with: uses: subosito/flutter-action@v2
channel: 'stable' id: flutter-action
- run: | with:
echo CACHE-PATH=${{ steps.flutter-action.outputs.CACHE-PATH }} channel: stable
echo CACHE-KEY=${{ steps.flutter-action.outputs.CACHE-KEY }} - run: |
echo CHANNEL=${{ steps.flutter-action.outputs.CHANNEL }} echo CACHE-PATH=${{ steps.flutter-action.outputs.CACHE-PATH }}
echo VERSION=${{ steps.flutter-action.outputs.VERSION }} echo CACHE-KEY=${{ steps.flutter-action.outputs.CACHE-KEY }}
echo ARCHITECTURE=${{ steps.flutter-action.outputs.ARCHITECTURE }} echo CHANNEL=${{ steps.flutter-action.outputs.CHANNEL }}
echo PUB-CACHE-PATH=${{ steps.flutter-action.outputs.PUB-CACHE-PATH }} echo VERSION=${{ steps.flutter-action.outputs.VERSION }}
echo PUB-CACHE-KEY=${{ steps.flutter-action.outputs.PUB-CACHE-KEY }} echo ARCHITECTURE=${{ steps.flutter-action.outputs.ARCHITECTURE }}
shell: bash echo PUB-CACHE-PATH=${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}
echo PUB-CACHE-KEY=${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}
shell: bash
``` ```