diff --git a/.github/workflows/ci-compare.yml b/.github/workflows/ci-compare.yml new file mode 100644 index 0000000..1ce9378 --- /dev/null +++ b/.github/workflows/ci-compare.yml @@ -0,0 +1,34 @@ +name: CI for comparison + +on: + workflow_dispatch: + +defaults: + run: + shell: bash + +jobs: + test-uncached-jobs: + runs-on: ${{ matrix.runner }} + strategy: + matrix: + runner: [ ubuntu-latest, windows-latest, macos-latest ] + steps: + - uses: actions/checkout@v3 + - name: Setup Flutter + uses: ./ + with: + actionsCacheKey: 'flutter-${{ runner.os }}-compare' + + test-cached-jobs: + needs: test-uncached-jobs + runs-on: ${{ matrix.runner }} + strategy: + matrix: + runner: [ ubuntu-latest, windows-latest, macos-latest ] + steps: + - uses: actions/checkout@v3 + - name: Setup Flutter + uses: ./ + with: + actionsCacheKey: 'flutter-${{ runner.os }}-compare' diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 31c3111..3330cbb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,10 +21,9 @@ jobs: strategy: fail-fast: false matrix: -# runner: [ ubuntu-latest, windows-latest ] runner: [ ubuntu-latest, windows-latest, macos-latest ] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: ./ - run: flutter --version @@ -36,86 +35,94 @@ jobs: if: runner.os == 'Windows' shell: powershell -# TODO: Add test-setup-flutter-with-setFlutterRootPath + test-with-ref: + needs: test-basic + runs-on: ${{ matrix.runner }} + strategy: + fail-fast: false + matrix: + runner: [ ubuntu-latest ] + steps: + - uses: actions/checkout@v3 + - name: Setup Flutter + uses: ./ + with: + ref: 'beta' - test-with-setPubCachePath: + test-with-actionsCache: + needs: test-basic runs-on: ${{ matrix.runner }} strategy: fail-fast: false matrix: -# runner: [ ubuntu-latest ] - runner: [ ubuntu-latest, macos-latest ] - pubCachePath: [ '$HOME/.pub-cache-new' ] - include: - - runner: windows-latest - pubCachePath: '$LOCALAPPDATA\NewPub\Cache' - - runner: ubuntu-latest - pubCachePath: '/home/runner/.pub-cache-new' - - runner: windows-latest - pubCachePath: 'C:\Users\runneradmin\AppData\Local\NewPub\Cache' - - runner: macos-latest - pubCachePath: '/Users/runner/.pub-cache-new' + runner: [ ubuntu-latest ] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: ./ with: - setPubCachePath: ${{ matrix.pubCachePath }} - - run: | - set -x - flutter create myapp - cd myapp - flutter pub get - ls $PUB_CACHE/hosted/pub.dev + actionsCache: 'false' - test-with-addPubCacheBinToPath: + test-with-flutterPrecache: + needs: test-basic runs-on: ${{ matrix.runner }} strategy: fail-fast: false matrix: -# runner: [ ubuntu-latest, windows-latest ] - runner: [ ubuntu-latest, windows-latest, macos-latest ] + include: + - runner: ubuntu-latest + actionsCache: 'true' + - runner: ubuntu-latest + actionsCache: 'false' steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: ./ with: - setFlutterRootPath: 'true' - addPubCacheBinToPath: 'true' - - run: dart pub global activate devtools - - if: runner.os != 'Windows' - run: devtools --help - - if: runner.os == 'Windows' - shell: pwsh - run: devtools --help - - run: | - DEFAULT_PUB_CACHE=$(./src/get-pub-cache-path.sh) - echo "::debug::DEFAULT_PUB_CACHE=$DEFAULT_PUB_CACHE" - ls $DEFAULT_PUB_CACHE/global_packages + actionsCache: ${{ matrix.actionsCache }} + flutterPrecache: '--linux --web' - test-with-all: + test-with-almost-all: runs-on: ${{ matrix.runner }} strategy: fail-fast: false matrix: -# runner: [ ubuntu-latest ] runner: [ ubuntu-latest, macos-latest ] - pubCachePath: [ '$HOME/.pub-cache-new' ] + pubCachePath: [ '$HOME/.pub-cache-foo' ] include: - runner: windows-latest - pubCachePath: '$LOCALAPPDATA\NewPub\Cache' + pubCachePath: '$LOCALAPPDATA\FooPub\Cache' steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: ./ with: + installationPath: '${{ runner.tool_cache }}/flutter-foo' + actionsCacheKey: 'flutter-${{ runner.os }}-almost-all' setFlutterRootPath: 'true' setPubCachePath: ${{ matrix.pubCachePath }} addPubCacheBinToPath: 'true' - - run: dart pub global activate devtools + flutterPrecache: 'true' + # installationPath + - run: type -a flutter + # setFlutterRootPath + - if: runner.os != 'Windows' + run: echo "FLUTTER_ROOT=$FLUTTER_ROOT" + - if: runner.os == 'Windows' + shell: pwsh + run: echo "FLUTTER_ROOT=$FLUTTER_ROOT" + # setPubCachePath + - run: | + set -x + flutter create myapp + cd myapp + flutter pub get + ls $PUB_CACHE/hosted/pub.dev + # addPubCacheBinToPath + - run: dart pub global activate markdown - if: runner.os != 'Windows' - run: devtools --help + run: markdown --help - if: runner.os == 'Windows' shell: pwsh - run: devtools --help + run: markdown --help - run: ls $PUB_CACHE/global_packages diff --git a/.gitignore b/.gitignore index 3c3629e..485dee6 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -node_modules +.idea diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 26d3352..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index 639900d..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 098e84b..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/scopes/Except__gitignored.xml b/.idea/scopes/Except__gitignored.xml deleted file mode 100644 index 11f6cfb..0000000 --- a/.idea/scopes/Except__gitignored.xml +++ /dev/null @@ -1,3 +0,0 @@ - - - \ No newline at end of file diff --git a/.idea/setup-flutter.iml b/.idea/setup-flutter.iml deleted file mode 100644 index d6ebd48..0000000 --- a/.idea/setup-flutter.iml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 35eb1dd..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d9812e..e05cd70 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,30 +6,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.3.0] - 2023-03-25 +### Added +- Inputs `installationPath`, `actionsCache`, `actionsCacheKey` and `flutterPrecache`. + +### Removed +- depth 1 from git clone command, so that Flutter tool can construct version from non-tagged references. + ## [1.2.0] - 2021-12-29 ### Changed -- Input `setPubCachePath`

+- Input `setPubCachePath` - For Windows runners, it now accepts bash understandable paths instead of
- pwsh understandable paths.
- Example: Previously -
- `setPubCachePath: '$env:LOCALAPPDATA\Pub\Cache'`
- Now -
- `setPubCachePath: '$LOCALAPPDATA\Pub\Cache'`

+ For Windows runners, it now accepts bash understandable paths instead of pwsh understandable paths. + Example: Previously - + `setPubCachePath: '$env:LOCALAPPDATA\Pub\Cache'` + Now - + `setPubCachePath: '$LOCALAPPDATA\Pub\Cache'` - For Ubuntu and macOS runners, avoid using tilde `~` in paths.
- Example: Previously -
- `setPubCachePath: '~/.pub-cache'`
- Now -
- `setPubCachePath: '$HOME/.pub-cache'`
+ For Ubuntu and macOS runners, avoid using tilde `~` in paths. + Example: Previously - + `setPubCachePath: '~/.pub-cache'` + Now - + `setPubCachePath: '$HOME/.pub-cache'` ## [1.1.1] - 2021-12-23 ### Fixed -- Input addPubCacheBinToPath +- Input `addPubCacheBinToPath` ## [1.1.0] - 2021-12-22 ### Added -- Inputs setFlutterRootPath, setPubCachePath and addPubCacheBinToPath. +- Inputs `setFlutterRootPath`, `setPubCachePath` and `addPubCacheBinToPath`. ## [1.0.0] - 2021-12-10 Initial release diff --git a/README.md b/README.md index ac6f2e5..5b97569 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ Composite GitHub Action to setup and cache the Flutter SDK. -Caching Flutter will help to save some minutes.
-Private repositories with Free plan has only 2,000 automation minutes/month.
-And the minutes are counted as -
-Linux - 1 minute counted as 1 regular minute.
-Windows - 1 minute counted as 2 regular minutes.
-macOS - 1 minute counted as 10 regular minutes.
+Caching Flutter will help to save some minutes. +Private repositories with Free plan has only 2,000 automation minutes/month. +And the minutes are counted as - +Linux - 1 minute counted as 1 regular minute. +Windows - 1 minute counted as 2 regular minutes. +macOS - 1 minute counted as 10 regular minutes. Usage for the month can be seen in https://github.com/settings/billing Stats from workflow runs of before and after caching - @@ -55,70 +55,179 @@ Stats from workflow runs of before and after caching - # Please Note -- This action is intended for the **Hosted Runners**. -- Flutter is installed via GitHub repository source and not via
- `https://storage.googleapis.com` source which comes with [Installation Bundles][]. +- Flutter is installed via GitHub repository source and not via `https://storage.googleapis.com` source. The later source comes with [Installation Bundles]. + See also, [Flutter's Official Installation]. - GitHub will remove any cache entries that have not been accessed in over 7 days. +- This action is intended for the **GitHub-hosted runners**. + Not tested on the **Self-hosted runners**. -# Planned Future releases +# Usage -- Support for the Self Hosted Runners. -- Flutter installation via `https://storage.googleapis.com` source as well.
- Like done in https://github.com/subosito/flutter-action -- Support for the caret versioning. +## Basic +```yml +steps: + - uses: actions/checkout@v3 + - name: Setup Flutter + uses: hrishikesh-kadam/setup-flutter@v1 + - run: # Run your flutter or dart command here +``` -# Usage +## `ref` -Basic - + + + + + + + + + + + + + +
descriptionchannel (stable, beta or master), version(3.7.8) or any git reference(3.9.0-0.1.pre).
requiredfalse
default'stable'
```yml steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: hrishikesh-kadam/setup-flutter@v1 - - run: # Run your flutter or dart command here + with: + ref: beta # or 3.7.8 or 3.9.0-0.1.pre +``` + +## `installationPath` + + + + + + + + + + + + + + +
descriptionInstallation Path of Flutter SDK.
requiredfalse
default'${{ runner.tool_cache }}/flutter'
+ +```yml +steps: + - uses: actions/checkout@v3 + - name: Setup Flutter + uses: hrishikesh-kadam/setup-flutter@v1 + with: + installationPath: '${{ runner.tool_cache }}/flutter-foo' +``` + +## `actionsCache` + + + + + + + + + + + + + + +
descriptionCache Flutter SDK for subsequent GitHub Actions Workflow.
requiredfalse
default'true'
+ +```yml +steps: + - uses: actions/checkout@v3 + - name: Setup Flutter + uses: hrishikesh-kadam/setup-flutter@v1 + with: + actionsCache: 'false' ``` -ref:
-    description: 'channel (stable, beta or master), version(2.8.1) or any git reference(2.9.0-0.1.pre).'
-    required: false
-    default: 'stable'
+## `actionsCacheKey` + + + + + + + + + + + + + + +
descriptionAn explicit key for a cache entry.
+ Default key will be computed as `flutter-{OS}-{ref}-{ref_head}`. +
requiredfalse
default''
```yml steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: hrishikesh-kadam/setup-flutter@v1 with: - ref: beta # or 2.8.1 or 2.9.0-0.1.pre, + actionsCacheKey: 'flutter-${{ runner.os }}' ``` -setFlutterRootPath:
-    description: 'Set FLUTTER_ROOT to path where Flutter is installed.'
-    required: false
-    default: 'false'
+## `setFlutterRootPath` + + + + + + + + + + + + + + +
descriptionSet FLUTTER_ROOT to path where Flutter is installed.
requiredfalse
default'false'
+ ```yml steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: hrishikesh-kadam/setup-flutter@v1 with: setFlutterRootPath: 'true' ``` -setPubCachePath:
-    description: 'Set PUB_CACHE to desired path, where pub saves dependencies.'
-    required: false
-    default: ''
+## `setPubCachePath` + + + + + + + + + + + + + + +
descriptionSet PUB_CACHE to desired path, where pub saves dependencies.
requiredfalse
default''
```yml my-job: runs-on: ${{ matrix.runner }} strategy: - fail-fast: false matrix: runner: [ ubuntu-latest, macos-latest ] pubCachePath: [ '$HOME/.pub-cache' ] @@ -126,31 +235,75 @@ my-job: - runner: windows-latest pubCachePath: '$LOCALAPPDATA\Pub\Cache' steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: hrishikesh-kadam/setup-flutter@v1 with: setPubCachePath: ${{ matrix.pubCachePath }} ``` -addPubCacheBinToPath:
-    description: 'Add PUB_CACHE bin to PATH.
-        Note: On Windows, activated global packages can be run by without specifying
-        `dart pub global run` only on pwsh, cmd and powershell.'
-    required: false
-    default: 'false'
+## `addPubCacheBinToPath` + + + + + + + + + + + + + + +
descriptionAdd PUB_CACHE bin to PATH.
+ Note: On Windows, activated global packages can be run by without specifying dart pub global run only on pwsh, cmd and powershell. +
requiredfalse
default'false'
```yml steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Flutter uses: hrishikesh-kadam/setup-flutter@v1 with: addPubCacheBinToPath: 'true' - run: | - dart pub global activate devtools - devtools --help + dart pub global activate markdown + markdown --help +``` + +## `flutterPrecache` + + + + + + + + + + + + + + +
descriptionPopulate the Flutter tool's cache of binary artifacts.
+ For additional download options, see flutter help precache. +
requiredfalse
default'false'
+ +```yml +steps: + - uses: actions/checkout@v3 + - name: Setup Flutter + uses: hrishikesh-kadam/setup-flutter@v1 + with: + flutterPrecache: 'true' + # will execute `flutter precache` + # flutterPrecache: '--linux --web' + # will execute `flutter precache --linux --web` ``` [Installation Bundles]: https://github.com/flutter/flutter/wiki/Flutter-Installation-Bundles +[Flutter's Official Installation]: https://docs.flutter.dev/get-started/install diff --git a/action.yml b/action.yml index faae6c0..c7a7bd9 100644 --- a/action.yml +++ b/action.yml @@ -1,11 +1,24 @@ -name: 'Setup and cache Flutter SDK' +name: 'hrk-setup-flutter' author: 'Hrishikesh Kadam ' description: 'Composite GitHub Action to setup and cache the Flutter SDK.' inputs: ref: - description: 'channel (stable, beta or master), version(2.8.1) or any git reference(2.9.0-0.1.pre).' + description: 'Channel (stable, beta or master), version(3.7.8) or any git reference(3.9.0-0.1.pre).' required: false default: 'stable' + installationPath: + description: 'Installation Path of Flutter SDK.' + required: false + default: '${{ runner.tool_cache }}/flutter' + actionsCache: + description: 'Cache Flutter SDK for subsequent GitHub Actions Workflow.' + required: false + default: 'true' + actionsCacheKey: + description: 'An explicit key for a cache entry. + Default key will be computed as `flutter-{OS}-{ref}-{ref_head}`.' + required: false + default: '' setFlutterRootPath: description: 'Set FLUTTER_ROOT to path where Flutter is installed.' required: false @@ -20,36 +33,46 @@ inputs: `dart pub global run` only on pwsh, cmd and powershell.' required: false default: 'false' + flutterPrecache: + description: "Populate the Flutter tool's cache of binary artifacts. + For additional download options, see `flutter help precache`." + required: false + default: 'false' runs: using: 'composite' steps: - - name: Check Flutter ${{ inputs.ref }} HEAD - run: | - echo "FLUTTER_REF_HEAD=$(git ls-remote https://github.com/flutter/flutter ${{ inputs.ref }} | cut -f 1)" >> $GITHUB_ENV + - name: Run init script + run: $GITHUB_ACTION_PATH/src/init.sh shell: bash + env: + SETUP_FLUTTER_REF: ${{ inputs.ref }} + SETUP_FLUTTER_INSTALLATION_PATH: ${{ inputs.installationPath }} + SETUP_FLUTTER_ACTIONS_CACHE: ${{ inputs.actionsCache }} + SETUP_FLUTTER_ACTIONS_CACHE_KEY: ${{ inputs.actionsCacheKey }} - name: Check if Flutter is cached + if: inputs.actionsCache == 'true' id: cache-flutter - uses: actions/cache@v2 + uses: actions/cache@v3 with: - path: ${{ runner.tool_cache }}/flutter - key: flutter-${{ runner.os }}-${{ inputs.ref }}-${{ env.FLUTTER_REF_HEAD }} + path: ${{ env.SETUP_FLUTTER_INSTALLATION_PATH }} + key: ${{ env.SETUP_FLUTTER_ACTIONS_CACHE_KEY }} - name: Clone Flutter repository if not cached - if: steps.cache-flutter.outputs.cache-hit != 'true' + if: inputs.actionsCache != 'true' || steps.cache-flutter.outputs.cache-hit != 'true' run: | - git clone --branch ${{ inputs.ref }} --depth 1 \ - https://github.com/flutter/flutter $RUNNER_TOOL_CACHE/flutter + git clone --branch ${{ inputs.ref }} \ + https://github.com/flutter/flutter $SETUP_FLUTTER_INSTALLATION_PATH shell: bash - name: Set FLUTTER_ROOT path if: inputs.setFlutterRootPath == 'true' - run: $GITHUB_ACTION_PATH/src/set-flutter-root.sh + run: echo "FLUTTER_ROOT=$SETUP_FLUTTER_INSTALLATION_PATH" >> $GITHUB_ENV shell: bash - name: Add Flutter to PATH - run: echo "$RUNNER_TOOL_CACHE/flutter/bin" >> $GITHUB_PATH + run: echo "$SETUP_FLUTTER_INSTALLATION_PATH/bin" >> $GITHUB_PATH shell: bash - name: Set PUB_CACHE path @@ -62,6 +85,19 @@ runs: run: $GITHUB_ACTION_PATH/src/add-pub-cache-bin-to-path.sh shell: bash + - name: Run Flutter Precache + if: inputs.flutterPrecache != 'false' && + (inputs.actionsCache != 'true' || steps.cache-flutter.outputs.cache-hit != 'true') + run: | + if [[ "${{ inputs.flutterPrecache }}" == "true" ]]; then + set -x + flutter precache + else + set -x + flutter precache ${{ inputs.flutterPrecache }} + fi + shell: bash + - run: flutter --version shell: bash diff --git a/src/add-pub-cache-bin-to-path.sh b/src/add-pub-cache-bin-to-path.sh index 1f7f692..b84a1ca 100755 --- a/src/add-pub-cache-bin-to-path.sh +++ b/src/add-pub-cache-bin-to-path.sh @@ -2,10 +2,10 @@ PUB_CACHE=$("$GITHUB_ACTION_PATH"/src/get-pub-cache-path.sh) -if [[ $RUNNER_OS == 'Windows' ]]; then +if [[ $RUNNER_OS == "Windows" ]]; then PUB_CACHE_BIN="$PUB_CACHE\bin" else - PUB_CACHE_BIN=$PUB_CACHE/bin + PUB_CACHE_BIN="$PUB_CACHE/bin" fi echo "::debug::Adding $PUB_CACHE_BIN to \$GITHUB_PATH" diff --git a/src/init.sh b/src/init.sh new file mode 100755 index 0000000..86e1455 --- /dev/null +++ b/src/init.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash + +echo "SETUP_FLUTTER_INSTALLATION_PATH=$SETUP_FLUTTER_INSTALLATION_PATH" \ + >> "$GITHUB_ENV" + +if [[ $SETUP_FLUTTER_ACTIONS_CACHE == "true" ]]; then + SETUP_FLUTTER_REF_HEAD="$( \ + git ls-remote https://github.com/flutter/flutter "$SETUP_FLUTTER_REF" \ + | cut -f 1)" + echo "SETUP_FLUTTER_REF_HEAD=$SETUP_FLUTTER_REF_HEAD" >> "$GITHUB_ENV" + + if [[ $SETUP_FLUTTER_ACTIONS_CACHE_KEY == "" ]]; then + SETUP_FLUTTER_ACTIONS_CACHE_KEY="flutter-$RUNNER_OS-$SETUP_FLUTTER_REF-$SETUP_FLUTTER_REF_HEAD" + fi + echo "SETUP_FLUTTER_ACTIONS_CACHE_KEY=$SETUP_FLUTTER_ACTIONS_CACHE_KEY" \ + >> "$GITHUB_ENV" +fi diff --git a/src/set-flutter-root.sh b/src/set-flutter-root.sh deleted file mode 100755 index 75403d5..0000000 --- a/src/set-flutter-root.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env bash - -if [[ $RUNNER_OS == 'Windows' ]]; then - echo "FLUTTER_ROOT=$RUNNER_TOOL_CACHE\flutter" >> "$GITHUB_ENV" -else - echo "FLUTTER_ROOT=$RUNNER_TOOL_CACHE/flutter" >> "$GITHUB_ENV" -fi