GithubActionsでDockerのbuildをキャッシュで時短!

image

こんにちは!Mukaigaです。
以前は可茂IT塾でインターンしておりましたが、今年度からは東京の会社でWebエンジニアをしております!

解決したい問題

Docker(Compose)で作成したアプリを、GithubActionsでBuildしていたのですが、ぼちぼち遅い。

cacheを使用したCI

name: ci
on:
  push:

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3

      # buildxを使用
      - name: set up docker buildx
        id: buildx
        uses: docker/setup-buildx-action@v2

      - name: cache docker layers
        uses: actions/cache@v3
        with:
          path: /tmp/.buildx-cache
          key: ${{ github.ref }}-${{ github.sha }}
          restore-keys: |
            ${{ github.ref }}
            refs/head/master

      # node_modulesをキャッシュ
      - name: cache node_modules
        uses: actions/cache@v3
        id: cache-node-modules
        with:
          path: /tmp/.node_modules
          # hashFilesでpackage-lock.jsonの変更を検知
          key: ${{ runner.os }}-node_modules-${{ hashFiles('*/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-

      # Dockerfileからイメージをビルド 
      - name: build docker image
        uses: docker/build-push-action@v3
        with:
          builder: ${{ steps.buildx.outputs.name }}
          tags: dev_next:latest
          push: false
          load: true
          file: Dockerfile
          cache-from: type=local,src=/tmp/.buildx-cache
          cache-to: type=local,dest=/tmp/.buildx-cache-new

      # Docker Composeでコンテナを起動
      - name: docker compose up
        run: |
          mkdir -p /tmp/.node_modules
          docker compose up -d

      # yarn installなどのコマンドを実行
      - name: yarn install
        run: |
          docker compose exec dev_next sh -c "yarn install --frozen-lockfile"

      - name: yarn build
        run: |
          docker compose exec dev_next sh -c "yarn build"

      - name: yarn lint
        run: |
          docker compose exec dev_next sh -c "yarn lint"

      - name: Move cache
        run: |
          rm -rf /tmp/.buildx-cache
          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

actions/cache

      # node_modulesをキャッシュ
      - name: cache node_modules
        uses: actions/cache@v3
        id: cache-node-modules
        with:
          path: /tmp/.node_modules
          # hashFilesでpackage-lock.jsonの変更を検知
          key: ${{ runner.os }}-node_modules-${{ hashFiles('*/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-

このように、キャッシュしたい箇所でactions/cache@v3を使用しています。
リポジトリ:https://github.com/actions/cache
参考:https://docs.github.com/ja/actions/using-workflows/caching-dependencies-to-speed-up-workflows

このアクションは、一意のキーによって識別されるキャッシュを作成し、復元します。

とあるように、keyに紐づくキャッシュを作ってくれます。

キャッシュがある場合にはそれを使用し、ない場合には作ってくれます!

上記の例だと、keyは以下のようになっています。

key: ${{ runner.os }}-node_modules-${{ hashFiles('*/package-lock.json') }}

*/package-lock.jsonは、プロジェクトのpackage-lock.jsonを探します。 hashFilesでハッシュ化した値をキーとしています。

なので、packageが更新された場合に、新しいキャッシュを作ることができます。 また変更がない場合、keyが同じになるので、既存のキャッシュを使用することができます。

同じように、dockerのlayerもcacheしています。

お知らせ

可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!可茂IT塾のエンジニアの判断で、一定以上のスキルをを習得した方には有給でのインターンも受け入れています。

Read More
U30可茂ITインターンハッカソン

U30可茂ITインターンハッカソン

12月28,29日開催。2日間でアプリ開発の企画から完成までを目指す!U30可茂ITインターンハッカソンを開催します。

Read More

関連の記事

タグ

Flutter (110)初心者向け (28)イベント (18)Google Apps Script (15)Nextjs (12)可茂IT塾 (8)Firebase (7)riverpod (6)React (6)ChatGPT (5)vscode (5)デザイン (5)新卒 (4)就活 (4)Figma (4)Dart (4)JavaScript (4)お知らせ (4)FlutterWeb (3)Prisma (3)NestJS (3)Slack (3)TypeScript (3)ワーケーション (3)インターン (3)設計 (2)線型計画法 (2)事例 (2)Git (2)Image (2)File (2)Material Design (2)画像 (2)iOS (2)アプリ開発 (2)React Hooks (2)tailwindcss (2)社会人 (2)大学生 (2)RSS (1)Google (1)Web (1)CodeRunner (1)個人開発 (1)Android (1)Unity (1)WebView (1)Twitter (1)フルリモート (1)TextScaler (1)textScaleFactor (1)学生向け (1)supabase (1)Java (1)Spring Boot (1)shell script (1)正規表現 (1)パワーポイント (1)趣味 (1)モンスターボール (1)CSS (1)SCSS (1)Cupertino (1)ListView (1)就活浪人 (1)既卒 (1)保守性 (1)iPad (1)シェアハウス (1)スクレイピング (1)PageView (1)画面遷移 (1)flutter_hooks (1)Gmail (1)GoogleWorkspace (1)ShaderMask (1)google map (1)Google Places API (1)GCPコンソール (1)Google_ML_Kit (1)Vercel (1)Google Domains (1)DeepLeaning (1)深層学習 (1)Google Colab (1)コード生成 (1)GitHub Copilot (1)オンラインオフィス (1)オブジェクト指向 (1)クラスの継承 (1)ポリモーフィズム (1)LINE (1)Bitcoin (1)bitFlyer (1)コミュニティー (1)文系エンジニア (1)Freezed (1)permission_handler (1)flutter_local_notifications (1)markdown (1)GlobalKey (1)ValueKey (1)Key (1)アイコン (1)go_router (1)debug (1)datetime_picker (1)Apple Store Connect (1)FlutterGen (1)デバッグ (1)Widget Inspector (1)検索機能 (1)Shader (1)Navigator (1)メール送信 (1)Firebase App Distribution (1)Fastlane (1)Dio (1)CustomClipper (1)ClipPath (1)カスタム認証 (1)アニメーション (1)Arduino (1)ESP32 (1)経験談 (1)フリーランス (1)mac (1)csv (1)docker (1)GithubActions (1)Dialog (1)BI (1)LifeHack (1)ショートカット (1)Chrome (1)高校生 (1)キャリア教育 (1)非同期処理 (1)生体認証 (1)BackdropFilter (1)レビュー (1)getAuth (1)Algolia (1)コンサルティング (1)Symbol (1)

お知らせ

可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!可茂IT塾のエンジニアの判断で、一定以上のスキルをを習得した方には有給でのインターンも受け入れています。

Read More
U30可茂ITインターンハッカソン

U30可茂ITインターンハッカソン

12月28,29日開催。2日間でアプリ開発の企画から完成までを目指す!U30可茂ITインターンハッカソンを開催します。

Read More