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

Merge pull request #285 from subosito/format

Browse source 
Minor formatting changes
This commit is contained in:
Bartek Pacia 2024-03-31 19:37:58 +02:00 committed by GitHub
commit 7d86479cec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 311 additions and 257 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
.github/workflows/workflow.yml vendored
View file

@ -1,4 +1,5 @@
name: Main workflow
on:
push:
branches:
@ -12,20 +13,28 @@ on:
jobs:
lint_shellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ludeeus/action-shellcheck@master
- name: Clone repository
uses: actions/checkout@v4
- name: Run shellcheck
uses: ludeeus/action-shellcheck@master
test_channel:
runs-on: ${{ matrix.operating-system }}
strategy:
matrix:
operating-system: [ubuntu-latest, windows-latest, macos-latest, macos-13, macos-14]
operating-system:
[ubuntu-latest, windows-latest, macos-latest, macos-13, macos-14]
channel: [stable, beta, master]
include:
- operating-system: ubuntu-latest
channel: main
steps:
- uses: actions/checkout@v4
- name: Clone repository
uses: actions/checkout@v4
- id: flutter-action
uses: ./
with:
@ -45,26 +54,34 @@ jobs:
shell: bash
- run: flutter --version
shell: bash
test_cache:
runs-on: ${{ matrix.operating-system }}
strategy:
matrix:
operating-system: [ubuntu-latest, windows-latest, macos-latest, macos-13, macos-14]
operating-system:
[ubuntu-latest, windows-latest, macos-latest, macos-13, macos-14]
steps:
- uses: actions/checkout@v4
- name: Clone repository
uses: actions/checkout@v4
- uses: ./
with:
channel: stable
flutter-version: '3.10.6'
flutter-version: "3.10.6"
cache: true
- run: dart --version
shell: bash
- run: flutter --version
shell: bash
test_print_output:
runs-on: macos-latest
steps:
- uses: actions/checkout@v4
- name: Clone repository
uses: actions/checkout@v4
- run: ./setup.sh -t -p | grep 'stable'
shell: bash
- run: ./setup.sh -t -p | grep '3.7.7'

130
README.md
View file

@ -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 }}

79
action.yml
View file

@ -1,73 +1,84 @@
name: 'Flutter action'
description: 'Setup your runner with Flutter environment'
author: 'Alif Rachmawadi'
name: Set up Flutter
description: Setup your runner with Flutter environment
author: Alif Rachmawadi
branding:
icon: 'maximize'
color: 'blue'
icon: maximize
color: blue
inputs:
flutter-version:
description: 'The Flutter version to make available on the path'
description: The Flutter version to make available on the path
required: false
default: 'any'
default: any
channel:
description: 'The Flutter build release channel'
description: The Flutter build release channel
required: false
default: 'stable'
default: stable
cache:
description: 'Cache the Flutter SDK'
description: Cache the Flutter SDK
required: false
default: 'false'
default: "false"
cache-key:
description: 'Identifier for the Flutter SDK cache'
description: Identifier for the Flutter SDK cache
required: false
default: 'flutter-:os:-:channel:-:version:-:arch:-:hash:'
default: "flutter-:os:-:channel:-:version:-:arch:-:hash:"
pub-cache-key:
description: 'Identifier for the Dart .pub-cache cache'
description: Identifier for the Dart .pub-cache cache
required: false
default: 'flutter-pub:os:-:channel:-:version:-:arch:-:hash:'
default: "flutter-pub:os:-:channel:-:version:-:arch:-:hash:"
cache-path:
description: 'Flutter SDK cache path'
description: Flutter SDK cache path
required: false
default: '${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:'
default: "${{ runner.tool_cache }}/flutter/:channel:-:version:-:arch:"
pub-cache-path:
description: 'Flutter pub cache path'
description: Flutter pub cache path
required: false
default: 'default'
default: default
architecture:
description: 'The architecture of Flutter SDK executable (x64 or arm64)'
description: The architecture of Flutter SDK executable (x64 or arm64)
required: false
default: '${{ runner.arch }}'
default: "${{ runner.arch }}"
outputs:
CACHE-PATH:
value: '${{ steps.flutter-action.outputs.CACHE-PATH }}'
CACHE-KEY:
value: '${{ steps.flutter-action.outputs.CACHE-KEY }}'
value: "${{ steps.flutter-action.outputs.CACHE-KEY }}"
description: Key used to cache the Flutter SDK
CACHE-PATH:
value: "${{ steps.flutter-action.outputs.CACHE-PATH }}"
description: Path to Flutter SDK
CHANNEL:
value: '${{ steps.flutter-action.outputs.CHANNEL }}'
value: "${{ steps.flutter-action.outputs.CHANNEL }}"
description: The selected Flutter release channel
VERSION:
value: '${{ steps.flutter-action.outputs.VERSION }}'
value: "${{ steps.flutter-action.outputs.VERSION }}"
description: The selected Flutter version
ARCHITECTURE:
value: '${{ steps.flutter-action.outputs.ARCHITECTURE }}'
value: "${{ steps.flutter-action.outputs.ARCHITECTURE }}"
description: The selected Flutter CPU architecture
PUB-CACHE-KEY:
value: '${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}'
value: "${{ steps.flutter-action.outputs.PUB-CACHE-KEY }}"
description: Key used to cache the pub dependencies
PUB-CACHE-PATH:
value: '${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}'
value: "${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}"
description: Path to pub cache
runs:
using: 'composite'
using: composite
steps:
- run: chmod +x $GITHUB_ACTION_PATH/setup.sh
- name: Make setup script executable
run: chmod +x "$GITHUB_ACTION_PATH/setup.sh"
shell: bash
- id: flutter-action
- name: Print configuration
id: flutter-action
run: $GITHUB_ACTION_PATH/setup.sh -p -c '${{ inputs.cache-path }}' -k '${{ inputs.cache-key }}' -d '${{ inputs.pub-cache-path }}' -l '${{ inputs.pub-cache-key }}' -n '${{ inputs.flutter-version }}' -a '${{ inputs.architecture }}' ${{ inputs.channel }}
shell: bash
- if: ${{ inputs.cache == 'true' }}
- name: Cache Flutter
if: ${{ inputs.cache == 'true' }}
uses: actions/cache@v4
with:
path: ${{ steps.flutter-action.outputs.CACHE-PATH }}
key: ${{ steps.flutter-action.outputs.CACHE-KEY }}
restore-keys: |
${{ steps.flutter-action.outputs.CACHE-KEY }}
- if: ${{ inputs.cache == 'true' }}
- name: Cache pub dependencies
if: ${{ inputs.cache == 'true' }}
uses: actions/cache@v4
with:
path: ${{ steps.flutter-action.outputs.PUB-CACHE-PATH }}