miyohideの日記

技術的なメモなどを記しています

2023年1月14日(土)GitHub ActionsにてGitHub Pagesにデプロイする

GitHub ActionsにてGitHub Pagesにデプロイする

GitHub Pagesに、個人アカウント用サイト、組織サイトの他にプロジェクト用のページも作れることを知り、また最近GitHub Actionsにてデプロイすることも可能となったようなので、試してみることにした。なお、これを書いている時点ではまだベータ版。

公式ドキュメントは以下のもの。

docs.github.com

実際に自分のプロジェクトでやってみる。テンプレートとして、Static Web Pageのものが出てきたのでそのコードをまずは眺める。

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content 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

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Pages
        uses: actions/configure-pages@v2
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          # Upload entire repository
          path: 'docs'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1

あまりピンとこないのだが、以下のような感じらしい。

  • environmentはプロジェクトページのEnvironmentsのところにリンクを載せることができる
  • GitHub Pagesにデプロイするものをactions/upload-pages-artifact@v1でアップロードする必要がある
  • 最後にactions/deploy-pages@v1を実行する。

以下の記事を色々と見ながら試行錯誤を繰り返すかな。

zenn.dev

www.satoryu.com