コンテンツにスキップ
開発ガイドライン
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

デプロイ

GitHub Actions などの CI/CD を使い、ブランチへのマージをきっかけに自動でデプロイする運用ルール

デプロイは GitHub Actions などの CI/CD で自動化し、ヒューマンエラーを減らします。

環境の分離

  • ステージング環境(staging): 本番と同等の構成で、公開前の確認に使う
  • 本番環境(production): 公開中のサイト

プロジェクトによっては、プレビュー環境や QA 環境を追加することもあります。

デプロイのトリガー

  • develop ブランチへのマージ: ステージング環境へ自動デプロイ
  • main ブランチへのマージ: 本番環境へ自動デプロイ(または手動承認後)

ブランチの運用はブランチ戦略を参照してください。

ワークフロー例

develop と main へのマージは PR 経由に限り、PR では CI の成功を必須にしています(ブランチ保護を参照)。 そのため、デプロイのワークフローでは Lint やテストを再実行せず、ビルドとデプロイだけを行います。 develop / main への push では CI ワークフローとデプロイワークフローが別々に走り、マージ時に CI でチェック済みである前提です(CI)。

ステージング環境へのデプロイ

name: Deploy to Staging

on:
  push:
    branches: [develop]

permissions:
  contents: read

# 同じ環境へのデプロイを同時に実行しない
concurrency:
  group: deploy-staging
  cancel-in-progress: false

jobs:
  deploy:
    runs-on: ubuntu-latest
    environment: staging

    steps:
      - uses: actions/checkout@v7
      - uses: pnpm/action-setup@v6
      - uses: actions/setup-node@v7
        with:
          node-version-file: ".nvmrc"
          cache: "pnpm"

      - run: pnpm install --frozen-lockfile
      - run: pnpm run build

      - name: Deploy to Staging
        # Cloudflare の場合の例。値は Environment(staging)の Secrets から読み込まれる
        env:
          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
        # デプロイ先に応じたコマンド(Cloudflare、Vercel など)
        run: pnpm run deploy:staging

本番環境へのデプロイ

name: Deploy to Production

on:
  push:
    branches: [main]

permissions:
  contents: read

concurrency:
  group: deploy-production
  cancel-in-progress: false

jobs:
  deploy:
    runs-on: ubuntu-latest
    # GitHub Environments で承認者(Required reviewers)を設定できる(プランの制約は後述)
    environment: production

    steps:
      - uses: actions/checkout@v7
      - uses: pnpm/action-setup@v6
      - uses: actions/setup-node@v7
        with:
          node-version-file: ".nvmrc"
          cache: "pnpm"

      - run: pnpm install --frozen-lockfile
      - run: pnpm run build

      - name: Deploy to Production
        # ステージング環境と同じ Secret 名で、Environment(production)の値が使われる
        env:
          CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
        run: pnpm run deploy:production

レンタルサーバーへのデプロイ

Cloudflare や Vercel を使わないレンタルサーバーの案件でも、GitHub Actions でビルドした成果物を配信します。

  • 接続方式: SSH が使えるサーバーでは、SFTP または rsync over SSH を使う。FTP しか使えない場合は FTPS(FTP over TLS)を使い、暗号化されない FTP は避ける
  • 認証情報: 接続先のホスト・ユーザー・秘密鍵やパスワードは Environment Secrets に登録し、ワークフローに直接書かない
  • 配信対象(静的サイト): リポジトリ直下などのビルド成果物(dist/)だけを配信する
  • 配信対象(WordPress): theme/ ディレクトリ全体を配信する(PHP ソース、functions/、テーマ内の dist/ など。テーマ内の dist/ は CI の pnpm run build で生成済み)。wp-content/uploads やプラグインなど、サーバー上で管理しているファイルを上書き・削除しない
- name: Deploy via rsync
  env:
    SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
    SSH_KNOWN_HOSTS: ${{ secrets.SSH_KNOWN_HOSTS }}
    SSH_DEST: ${{ secrets.SSH_DEST }} # 例: user@example.com:/home/user/example.com/public_html/
  run: |
    mkdir -p ~/.ssh
    echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_ed25519
    chmod 600 ~/.ssh/id_ed25519
    echo "$SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
    rsync -az dist/ "$SSH_DEST"
- name: Deploy theme via rsync
  env:
    SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
    SSH_KNOWN_HOSTS: ${{ secrets.SSH_KNOWN_HOSTS }}
    SSH_DEST: ${{ secrets.SSH_DEST }} # 例: user@example.com:/path/to/wp-content/themes/your-theme/
  run: |
    mkdir -p ~/.ssh
    echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_ed25519
    chmod 600 ~/.ssh/id_ed25519
    echo "$SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
    rsync -az theme/ "$SSH_DEST"

デプロイ時の注意

  • デプロイ後の確認: 本番環境で正常に動作しているか確認する
  • ロールバックの準備: 問題発生時にすぐ戻せる手順を用意しておく(ロールバックを参照)
  • デプロイの時間帯: アクセスの多い時間帯や、休日前・終業直前の本番デプロイは避ける

このページは役に立ちましたか?