GitHub ActionsからPagesに簡単にデプロイできるようになった

GitHub Actionsというのは、GitHubで継続的インテグレーション/デリバリー(CI/CD)を実現するための機能です。これを使うことで、GitHub Pagesにサイトをデプロイすることは、今までもできたのですが、サードパーティのactionを使う方法が一般的だったようです。しかしつい最近実装された機能で、ActionsからPagesにサイトを簡単にデプロイ可能になりました。詳しくはGitHub公式の記事GitHub Pages: Custom GitHub Actions Workflows (beta)を参照。

Workflowを作る

GitHub Actionsを使うためにはworkflowを作る必要があります。この記事では述べられていませんが、GitHubのstarter-workflowsを見ると、Next.jsやHugoなどでPagesにデプロイするためのworkflowが既に用意されています。ですが私はViteを使いたかったので、Gatsbyのworkflowを多少アレンジしてみたのがこちらです。

name: Deploy Vite site to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

# Default to bash
defaults:
  run:
    shell: bash

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Detect package manager
        id: detect-package-manager
        run: |
          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
            echo "::set-output name=manager::yarn"
            echo "::set-output name=command::install"
            exit 0
          elif [ -f "${{ github.workspace }}/package.json" ]; then
            echo "::set-output name=manager::npm"
            echo "::set-output name=command::ci"
            exit 0
          else
            echo "Unable to determine packager manager"
            exit 1
          fi
      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: "16"
          cache: ${{ steps.detect-package-manager.outputs.manager }}
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v1
      - name: Install dependencies
        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
      - name: Build with Vite
        run: ${{ steps.detect-package-manager.outputs.manager }} run build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./dist

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1

こちらのworkflowはVite用に書きましたが、あくまでnpm run buildして、生成されたdistディレクトリをGitHub Pagesで公開しているだけなので、Webpack等でも使えます。