開発フローを高速化・自動化する CI/CD 戦略：キャッシュ・並列実行・AI レビューの活用

2024/03/12に公開

2024/09/05

はじめに

CI/CD パイプラインの最適化は、開発の効率化とデプロイの信頼性向上に直結します。本記事では、以下の主要な最適化手法について解説し、実際の設定例やコードサンプルを紹介します。

本記事で紹介する最適化手法

キャッシュの活用でビルド時間を短縮
並列実行によりパイプラインの効率化
変更のあった部分のみのビルド・テストでリソースを最適化
Blue-Green / Canary デプロイによる安全なリリース
Terraform / Pulumi による自動プロビジョニングでインフラ管理の効率化
シークレット管理を最適化し、安全な CI/CD を実現する
エラー発生時のロールバック機能で安定性を向上
実行ログの可視化によりトラブルシューティングを容易に
セキュリティスキャンを自動化し、脆弱性を防ぐ
AI を活用し、PR のレビューとコード品質向上を推進

キャッシュの活用（npm / yarn / Docker のキャッシュ戦略を強化）

キャッシュを適切に活用することで、ビルド時間を短縮し、CI/CD の効率を向上させることができます。

GitHub Actions における npm / yarn キャッシュ

yaml
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: 'yarn'
      - run: yarn install --frozen-lockfile

この設定では、GitHub Actions で setup-node アクションを利用し、yarn.lock を基にキャッシュを作成します。次回のジョブ実行時にキャッシュが再利用されるため、依存関係のインストール時間が短縮されます。

Docker Build のキャッシュ最適化

# ベースイメージの指定
FROM node:18 AS builder

# 依存関係のインストールをキャッシュ
WORKDIR /app
COPY package.json yarn.lock ./
RUN yarn install --frozen-lockfile

# アプリケーションのコピーとビルド
COPY . .
RUN yarn build

この Dockerfile では、以下の最適化を行っています。

package.json と yarn.lock を先にコピーしてキャッシュを活用し、yarn install のリビルドを防ぐ。
マルチステージビルドを採用し、node_modules を別ステージで管理することで、本番環境に不要な依存関係を含めない。

これにより、ビルド時間の短縮だけでなく、Docker イメージのサイズ削減にも貢献できます。

並列実行によるパイプラインの高速化

ビルドやテストを並列で実行することで、パイプライン全体の時間を短縮できます。

CircleCI の並列実行例

yaml
version: 2.1
jobs:
  test:
    docker:
      - image: node:18
    parallelism: 4
    steps:
      - checkout
      - run: yarn install
      - run: yarn test --max-workers=4

この設定では、parallelism: 4 を指定することで、4つの並列プロセスでテストを実行します。yarn test --max-workers=4 により、テストプロセスが最大 4 つのワーカーで同時に実行され、全体の処理時間を短縮できます。

変更のあった部分のみをテスト・ビルドする仕組みの導入

モノレポ環境や大規模プロジェクトでは、変更のあった部分のみを対象にビルド・テストを実行することで、CI/CD の負荷を軽減できます。

GitHub Actions + Turborepo での最適化

yaml
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install dependencies
        run: yarn install
      - name: Build only affected packages
        run: yarn turbo run build --filter=.[HEAD^1..HEAD]

Turborepo を活用することで、前回のコミットからの変更を自動検出し、影響のあるパッケージのみをビルドできます。--filter=.[HEAD^1..HEAD] により、直近の変更が含まれるパッケージを対象にします。

Turborepoを使ったモノレポ構成に関するブログ記事もありますので合わせてご参照ください。

本番環境・ステージング環境へのデプロイ戦略策定（Blue-Green / Canary デプロイ）

Blue-Green デプロイの概要

2つの環境（Blue と Green）を用意し、一方を本番、一方を新バージョンの検証用に利用。
新バージョンが安定すればトラフィックを Green に切り替え、Blue を次のデプロイ用にリセット。

GitHub Actions + AWS CodeDeploy を使った Canary デプロイの例

yaml
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Deploy to AWS
        uses: aws-actions/aws-codedeploy-deploy@v1
        with:
          application-name: my-app
          deployment-group: canary-group
          traffic-routing-config: time-based-canary
          rollback-on-failure: true

AWS CodeDeploy を使うことで、新バージョンを段階的にリリースし、問題があれば即座にロールバックできます。

インフラの自動プロビジョニング（Terraform / Pulumi の適用）

Terraform による AWS インフラの構築

provider "aws" {
  region = "us-east-1"
}

resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-app-bucket"
  bucket_acl = "private"
}

Terraform を適用することで、手動作業を排除し、再現性のある環境を構築できます。

CI/CD セキュリティと AI 活用の最適化

CI/CD パイプラインの安全性と効率性を向上させるために、以下の項目について解説します。

シークレット管理の最適化

セキュリティリスクを最小限に抑えるため、適切なシークレット管理が必要です。以下の方法で、環境変数や機密情報を安全に管理できます。

GitHub Secrets の活用

GitHub Actions では secrets を使用して環境変数を安全に管理できます。

env:
  DATABASE_URL: ${{ secrets.DATABASE_URL }}

AWS Parameter Store の活用

AWS Systems Manager Parameter Store を使用して、クラウド環境でも安全にシークレットを管理できます。

aws ssm get-parameter --name "DATABASE_URL" --with-decryption --query Parameter.Value --output text

ロールバック機能の強化

デプロイ後に問題が発生した場合、自動的に前のバージョンへ戻す仕組みを導入することでシステムの安定性を確保できます。

GitHub Actions でのロールバック例

jobs:
  rollback:
    runs-on: ubuntu-latest
    steps:
      - name: 最新の安定リリースをデプロイ
        run: |
          git reset --hard previous-release
          git push origin HEAD --force

CI/CD の実行ログを可視化

Datadog や Grafana を統合し、ビルドやデプロイの状況を可視化することでトラブルシューティングを容易にします。

Datadog の導入

- name: Datadog Agent インストール
  run: |
    DD_AGENT_MAJOR_VERSION=7 DD_API_KEY=${{ secrets.DD_API_KEY }} DD_SITE="datadoghq.com" bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script.sh)"

可視化のユースケースとしては下記が挙げられます

ビルド時間の異常検知：過去の平均と比較し、異常な遅延を検出。
デプロイ失敗の傾向分析：失敗が多発するタイミングを特定。
セキュリティスキャンの結果をリアルタイム監視。

セキュリティスキャンの自動化

依存関係の脆弱性をスキャンし、未然にセキュリティリスクを防ぎます。またAI を活用することで、リスク分析の精度を向上させることも可能です。

Dependabot の設定例

.github/dependabot.yml:

version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "daily"
    labels:
      - "dependencies"
    assignees:
      - "your-github-username"
    commit-message:
      prefix: "chore(deps):"
    open-pull-requests-limit: 5
    ignore:
      - dependency-name: "react"
        versions: ["16.x"]

AI を活用してセキュリティ対策を強化する方法として、以下の技術が注目されています。

CodeQL（GitHub Advanced Security）：リポジトリのコードを解析し、セキュリティ脆弱性を検出。
Datadog の AI ベース異常検知：通常のログパターンから逸脱した動作を検出し、アラートを発生。
OpenAI API を活用した設定リスク検出：CI/CD 設定ファイルを解析し、リスクがある設定を指摘。

AI による PR の自動レビューと改善提案

AI を活用してコードレビューの自動化や品質向上を実現します。

GitHub Actions で CodeGPT を使用して PR のコードレビューを自動化

name: Code Review

permissions:
  contents: read
  pull-requests: write

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: anc95/ChatGPT-CodeReview@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          LANGUAGE: Japanese
          MODEL: gpt-4