GitHub Actions ワークフロー

目次

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

概要

GitHub Actions ワークフローを使用して、GitHub リポジトリから直接テスト、ビルド、セキュリティスキャン、デプロイメントプロセスを自動化できます。

使用場面

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

クイックスタート

最小限の動作例:

# .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/ ディレクトリの詳細な実装例:

ベストプラクティス

✅ 推奨事項

• 依存関係のキャッシング (npm, pip, Maven) を使用する
• matrix strategy でテストを並列実行する
• 保護されたブランチでステータスチェックを要求する
• 環境シークレットと変数を使用する
• if: で条件付きジョブを実装する
• テストの前にリントとフォーマットを実行する
• permissions で明示的にパーミッションを設定する
• 特定のハードウェア用にランナーラベルを使用する
• Docker レイヤーをキャッシュしてビルドを高速化する

❌ 非推奨事項

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