CI/CD パイプラインのセットアップ

目次

• 概要
• 使用する場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

コードをテストし、アーティファクトをビルドし、セキュリティチェックを実行し、最小限の手動介入で複数の環境にデプロイする自動化された継続的インテグレーションおよびデプロイメントパイプラインを構築します。

使用する場面

• 自動化されたコードテストおよび品質チェック
• コンテナ化されたアプリケーションビルド
• マルチ環境デプロイメント
• リリース管理とバージョニング
• 自動化されたセキュリティスキャン
• パフォーマンステストの統合
• アーティファクト管理とレジストリ

クイックスタート

最小限の動作例：

# .github/workflows/deploy.yml
name: Build and Deploy

on:
  push:
    branches:
      - main
      - develop
  pull_request:
    branches:
      - main
  workflow_dispatch:

env:
  REGISTRY: ghcr.io
  IMAGE_NAME: ${{ github.repository }}

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [18.x, 20.x]

    steps:
// ... (see reference guides for full implementation)

リファレンスガイド

references/ ディレクトリの詳細な実装：

ベストプラクティス

✅ すべき こと

• 早期検証で素早く失敗させる
• 可能な限りテストを並列実行する
• 依存関係のキャッシングを使用する
• 適切なシークレット管理を実装する
• 本番環境へのデプロイメントを承認でゲートする
• パイプラインの失敗を監視およびアラートする
• 一貫した環境設定を使用する
• インフラストラクチャアズコードを実装する

❌ すべきでは ない こと

• パイプライン設定に認証情報を保存する
• 自動化されたテストなしでデプロイする
• セキュリティスキャンをスキップする
• 長時間実行されるパイプラインを許可する
• ステージング環境と本番環境のパイプラインを混在させる
• テスト失敗を無視する
• メインブランチに直接デプロイする
• デプロイ後のヘルスチェックをスキップする