ストーリー

共有ライブラリの設計

アーキテクチャ

org/shared-workflows/          # メインリポジトリ
├── .github/
│   └── workflows/
│       ├── ci-standard.yml    # 標準CIパイプライン
│       ├── cd-staging.yml     # ステージングデプロイ
│       ├── cd-production.yml  # 本番デプロイ
│       ├── security-scan.yml  # セキュリティスキャン
│       └── release.yml        # リリースワークフロー
├── actions/                   # Composite Actions
│   ├── setup-node/
│   ├── setup-python/
│   ├── setup-go/
│   ├── docker-build/
│   ├── helm-deploy/
│   └── security/
│       ├── sast/
│       ├── sca/
│       └── container-scan/
├── policies/                  # OPAポリシー
├── templates/                 # テンプレート
└── docs/                      # ドキュメント

Reusable Workflow の設計原則

呼び出しインターフェース

# 各チームのリポジトリでの呼び出し例
name: CI/CD Pipeline
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  ci:
    uses: org/shared-workflows/.github/workflows/ci-standard.yml@v2
    with:
      language: "typescript"
      node-version: "20"
      test-command: "npm test"
      coverage-threshold: 80
    secrets: inherit

  deploy-staging:
    needs: ci
    if: github.ref == 'refs/heads/main'
    uses: org/shared-workflows/.github/workflows/cd-staging.yml@v2
    with:
      service-name: "my-service"
      cluster: "staging-eks"
    secrets: inherit

バージョニング戦略

SemVer によるバージョン管理

移行サポート

メジャーバージョンアップ時は、移行期間と移行ガイドを提供します。

バージョン移行タイムライン:

v1 (現行)  ──────────────→ サポート終了
                           ↑ 6ヶ月の移行期間
v2 (新版)  ───────→ 推奨 ──→ 必須
           リリース  3ヶ月   6ヶ月

Composite Action の設計

Reusable Workflowよりも粒度の細かい共有単位として、Composite Actionを設計します。

# actions/docker-build/action.yml
name: "Docker Build & Push"
description: "標準的なDockerイメージのビルドとプッシュ"
inputs:
  image-name:
    description: "イメージ名"
    required: true
  dockerfile:
    description: "Dockerfileのパス"
    default: "Dockerfile"
  push:
    description: "プッシュするかどうか"
    default: "true"
outputs:
  image-tag:
    description: "生成されたイメージタグ"
    value: ${{ steps.meta.outputs.tags }}

runs:
  using: "composite"
  steps:
    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v3

    - name: Login to GHCR
      uses: docker/login-action@v3
      with:
        registry: ghcr.io
        username: ${{ github.actor }}
        password: ${{ github.token }}

    - name: Build and Push
      uses: docker/build-push-action@v6
      with:
        context: .
        file: ${{ inputs.dockerfile }}
        push: ${{ inputs.push }}
        tags: ${{ steps.meta.outputs.tags }}
        cache-from: type=gha
        cache-to: type=gha,mode=max

共有ライブラリのテスト

ライブラリ自体の品質を担保するために、テストを実施します。

チームへのオンボーディング

セルフサービスオンボーディング

新しいチームが共有ライブラリを即座に使い始められるようにします。

「30分以内にパイプラインが動く状態にできなければ、そのライブラリは使われない。DX（Developer Experience）を最優先で設計しろ」 — 田中VPoE

まとめ

チェックリスト

• 共有ライブラリのアーキテクチャを理解した
• Reusable WorkflowとComposite Actionの使い分けを理解した
• バージョニングと移行戦略を理解した
• チームオンボーディングの重要性を理解した

次のステップへ

次は「テンプレートとポリシーエンジン」です。共有ライブラリをさらに発展させ、テンプレートリポジトリとポリシーエンジンによるガバナンスの自動化を学びましょう。

推定読了時間: 30分