cicd-pipeline-setup

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/ ディレクトリを参照してください。

ガイド	内容
GitHub Actions ワークフロー	GitHub Actions ワークフロー
GitLab CI パイプライン	GitLab CI パイプライン
Jenkins パイプライン	Jenkins パイプライン
CI/CD スクリプト	CI/CD スクリプト

ベストプラクティス

✅ 推奨事項

• 早期の検証で迅速に失敗させます
• 可能な場合はテストを並行して実行します
• 依存関係のキャッシュを使用します
• 適切なシークレット管理を実装します
• 承認を条件として本番環境へのデプロイを行います
• パイプラインの失敗を監視し、アラートを設定します
• 一貫性のある環境設定を使用します
• インフラストラクチャをコードとして実装します

❌ 禁止事項

• パイプライン設定に認証情報を保存しないでください
• 自動テストを実施せずにデプロイしないでください
• セキュリティスキャンを省略しないでください
• パイプラインの実行時間を長引かせないでください
• ステージング用と本番用のパイプラインを混在させないでください
• テストの失敗を無視しないでください
• main ブランチに直接デプロイしないでください
• デプロイ後のヘルスチェックを省略しないでください