github-actions-workflow

GitHub Actions ワークフロー

目次

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

概要

GitHub リポジトリから直接、テスト、ビルド、セキュリティスキャン、デプロイのプロセスを自動化する、強力な GitHub Actions ワークフローを作成できます。

使用する場面

• 継続的インテグレーションとテスト
• ビルドの自動化
• セキュリティスキャンと分析
• 依存関係の更新
• デプロイの自動化
• リリース管理
• コード品質のチェック

クイックスタート

最小限の実用的な例：

# .github/workflows/ci.yml
name: CI/CD Pipeline

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]

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

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [16.x, 18.x, 20.x]
    steps:
      - uses: actions/checkout@v3

      - name: Setup Node ${{ matrix.node-version }}
        uses: actions/setup-node@v3
        with:
// ... (see reference guides for full implementation)

リファレンスガイド

references/ ディレクトリにある詳細な実装：

ガイド	内容
完全な CI/CD ワークフロー	完全な CI/CD ワークフロー
リリースの自動化ワークフロー	リリースの自動化ワークフロー
Docker のビルドとプッシュ	Docker のビルドとプッシュ

ベストプラクティス

✅ 推奨事項

• 依存関係（npm、pip、Maven）にはキャッシュを使用します
• マトリックス戦略でテストを並列実行します
• 保護されたブランチでステータスチェックを必須にします
• 環境シークレットと変数を使用します
• if: で条件付きジョブを実装します
• テストの前にリントとフォーマットを実行します
• permissions で明示的な権限を設定します
• 特定のハードウェアにはランナーラベルを使用します
• ビルドを高速化するために Docker レイヤーをキャッシュします

❌ 禁止事項

• シークレットをワークフローファイルに保存しないでください
• 信頼できないコードをワークフローで実行しないでください
• フォークからのプルリクエストで secrets.* を使用しないでください
• 認証情報やトークンをハードコードしないでください
• continue-on-error によるエラー処理を見落とさないでください
• 過度に複雑なワークフローを作成しないでください
• プルリクエストでのテストを省略しないでください