[GH-224] GitHub Actions でキャッシュを利用するよう改善 #239

tatsutakein · 2024-06-05T05:35:30Z

概要

close: GitHub Actions でpubのキャッシュを利用 #224

GitHub Actions でキャッシュを利用するよう改善します．

キャッシュ用のジョブ ( cache-dependencies ) を挟むことで他のジョブ ( check, lint, diff-gen ) は高速化されていますが，トータルでみると少し遅くなったように感じます
- 今後他にも並列で走らせたいものが増える場合や，コード量が増える場合はこの構成が有効そうです
- 逆に今の規模からコード量が増えないのであればあまり効果がないように思えます

レビュー観点

コードに違和感がないか
CI が流れる状態となっているか（デグレしていないか）

レビューレベル

Lv1: ぱっとみて違和感がないかチェックして Approve する
Lv2: 仕様レベルまで理解して、仕様通りに動くかある程度検証して Approve する
Lv3: 実際に環境で動作確認したうえで Approve する

レビュー優先度

すぐに見てもらいたい ( hotfix など ) 🚀
今日中に見てもらいたい 🚗
今日〜明日中で見てもらいたい 🚶
数日以内で見てもらいたい 🐢

画像 / 動画

改善前

https://github.com/yumemi-inc/flutter-mobile-project-template/actions/runs/9378775404

改善後

独自で actions/cache を併用した場合

改善後（ cache-dependencies で初回キャッシュ有り）

https://github.com/yumemi-inc/flutter-mobile-project-template/actions/runs/9378814404/attempts/1

改善後（ cache-dependencies でキャッシュ復元）

https://github.com/yumemi-inc/flutter-mobile-project-template/actions/runs/9378814404

動作確認手順

備考

github-actions · 2024-06-05T05:38:00Z

Visit the preview URL for this PR (updated for commit 96db918):

https://flutter-mobile-project-template-catalog--pr239-feature-es9trved.web.app

_{(expires Wed, 12 Jun 2024 10:04:29 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 9ea56735a63d07a7cfe62eb204b0528284c37c23}

tatsutakein · 2024-06-05T06:11:56Z

.github/workflows/wc-changes.yml

変更箇所の検出で check-pr が肥大化しそうだったので workflow_call で分割しています．（この内容だったら job を並列で走らせたりしていないので action でも良かったかもです…）

今後 push イベントなど他のものでも使いやすいようになったかなと思います

tatsutakein · 2024-06-05T06:13:22Z

.github/workflows/check-pr.yaml

+  cache-dependencies:
+    runs-on: ubuntu-22.04
+    needs: changes
+    if: ${{ needs.changes.outputs.dependencies == 'true' }}
+    timeout-minutes: 10
+
+    steps:
+      # https://github.com/marketplace/actions/checkout
+      - name: Checkout
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+
+      - name: Setup Application Runtime
+        uses: ./.github/actions/setup-application-runtime


キャッシュがない場合を考慮して，一旦ここで一通りのセットアップ処理を実行します．
これにより，後続の処理では必ずキャッシュが復元されて高速化されます．

tatsutakein · 2024-06-05T06:14:23Z

.github/workflows/check-pr.yaml

@@ -8,51 +8,45 @@ concurrency:
  cancel-in-progress: true

 jobs:
-  pre-check:
+  changes:


わかりやすそうな名前に変更しています

tatsutakein · 2024-06-05T06:19:19Z

.github/actions/setup-application-runtime/action.yaml

-    # https://github.com/actions/cache
-    - name: cache pub
-      id: cache
-      uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
-      env:
-        cache-name: pub
-      with:
-        # pub-cache files are stored in `~/.pub-cache` on Linux/macOS
-        path: ~/.pub-cache
-        key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/pubspec.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/pubspec.lock') }}
-          ${{ runner.os }}-${{ env.cache-name }}-
-          ${{ runner.os }}-
-
-    - name: Path pub-cache
-      shell: bash
-      run: echo "$HOME/.pub-cache/bin" >> "$GITHUB_PATH"
-


subosito/flutter-action が同等のキャッシュをしていることに気づいたため，独自のキャッシュ処理を削除しています．

https://github.com/subosito/flutter-action/blob/44ac965b96f18d999802d4b807e3256d5a3f9fa1/action.yaml#L103-L111

ワークフロー実行時のログ
https://github.com/yumemi-inc/flutter-mobile-project-template/actions/runs/9378814404/job/25822833262#step:3:70

github-actions · 2024-06-05T06:20:18Z

Ready for review 🚀

tatsutakein · 2024-06-05T09:54:37Z

.github/workflows/wc-check-diff.yaml

+      # https://github.com/actions/cache
+      - name: Cache build runner
+        id: cache-build-runner
+        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        env:
+          cache-name: build-runner
+        with:
+          path: |
+            **/.dart_tool/build
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/asset_graph.json') }}-${{ hashFiles('**/pubspec.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/asset_graph.json') }}-${{ hashFiles('**/pubspec.lock') }}
+            ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/pubspec.lock') }}
+            ${{ runner.os }}-${{ env.cache-name }}-
+            ${{ runner.os }}-


#240 の内容を近しい場所で記載しています

github-actions · 2024-06-05T09:57:29Z

Ready for review 🚀

K9i-0

LGTM
コード生成のところちょっと不安だったので失敗する場合を試しましたが、大丈夫そうでした 👍
https://github.com/yumemi-inc/flutter-mobile-project-template/actions/runs/9393478411

ci: フィルタのワークフローを別ファイルで定義

475897f

github-actions bot assigned tatsutakein Jun 5, 2024

tatsutakein added 2 commits June 5, 2024 14:39

ci: キャッシュを利用するよう変更

4058a9b

ci: subosito/flutter-action が同等のキャッシュをしていたため独自のキャッシュを削除

02147fd

tatsutakein commented Jun 5, 2024

View reviewed changes

tatsutakein marked this pull request as ready for review June 5, 2024 06:19

yumemi-team-review-requester bot requested review from a team, morikann and K9i-0 and removed request for a team June 5, 2024 06:20

tatsutakein enabled auto-merge June 5, 2024 06:21

tatsutakein marked this pull request as draft June 5, 2024 08:13

auto-merge was automatically disabled June 5, 2024 08:13
Pull request was converted to draft

tatsutakein added 2 commits June 5, 2024 18:43

ci: build_runner のキャッシュ処理を追加

9d912ad

ci: custom_lint のジョブ名を変更

158e2f7

tatsutakein commented Jun 5, 2024

View reviewed changes

tatsutakein marked this pull request as ready for review June 5, 2024 09:57

tatsutakein enabled auto-merge June 5, 2024 09:57

ci: build_runner のキャッシュキーを調整

96db918

K9i-0 approved these changes Jun 6, 2024

View reviewed changes

tatsutakein merged commit e93bb39 into main Jun 6, 2024
10 checks passed

tatsutakein deleted the feature/GH-224 branch June 6, 2024 01:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GH-224] GitHub Actions でキャッシュを利用するよう改善 #239

[GH-224] GitHub Actions でキャッシュを利用するよう改善 #239

tatsutakein commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading

tatsutakein Jun 5, 2024

tatsutakein Jun 5, 2024

tatsutakein Jun 5, 2024

tatsutakein Jun 5, 2024

github-actions bot commented Jun 5, 2024

tatsutakein Jun 5, 2024

github-actions bot commented Jun 5, 2024

K9i-0 left a comment

[GH-224] GitHub Actions でキャッシュを利用するよう改善 #239

[GH-224] GitHub Actions でキャッシュを利用するよう改善 #239

Conversation

tatsutakein commented Jun 5, 2024 • edited Loading

概要

レビュー観点

レビューレベル

レビュー優先度

画像 / 動画

改善前

改善後

改善後（ cache-dependencies で初回キャッシュ有り）

改善後（ cache-dependencies でキャッシュ復元）

動作確認手順

備考

github-actions bot commented Jun 5, 2024 • edited Loading

tatsutakein Jun 5, 2024

Choose a reason for hiding this comment

tatsutakein Jun 5, 2024

Choose a reason for hiding this comment

tatsutakein Jun 5, 2024

Choose a reason for hiding this comment

tatsutakein Jun 5, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 5, 2024

tatsutakein Jun 5, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 5, 2024

K9i-0 left a comment

Choose a reason for hiding this comment

tatsutakein commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading