このブログ投稿では、GitHub Actionsを使用して、Hugo静的サイトをGitHub Pagesにデプロイする方法について説明します。GitHub Actionsは、GitHubが提供する自動化機能で、GitHubリポジトリ内でカスタムソフトウェア開発ワークフローを直接作成できます。GitHub Actionsを使用することで、Hugo静的サイトをGitHub Pagesにビルドしてデプロイするプロセスを簡単に自動化できます。

GitHub Pages設定の構成

GitHub Actionsを使用して、Hugo静的サイトをGitHub Pagesに正常にデプロイするには、プロジェクトのGitHub Pages設定を構成する必要があります。

  1. GitHubプロジェクトページに移動し、右上隅の「Settings」タブをクリックします。
  2. 「Pages」セクションにスクロールします。
  3. 「Build and deployment」設定で、「Source」ドロップダウンメニューを見つけます。
  4. 利用可能なオプションから「GitHub Actions」を選択します。これにより、GitHub PagesがGitHub Actionsで生成されたアーティファクトを使用してデプロイするようになります。

GitHub Pagesの設定を構成したので、hugo.yamlファイルで定義されたワークフローを使用してサイトをデプロイできるようになりました。

GitHub Pagesワークフローの設定

HugoとGitHub Actionsを使用したGitHub Pagesワークフローを設定するには、次の手順を実行します。

  1. Hugoサイトのリポジトリの.github/workflows/ディレクトリにhugo.yamlという名前の新しいファイルを作成します。
  2. 次のYAML構成をhugo.yamlファイルにコピーします：
name: Deploy Hugo 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

# Default to bash
defaults:
  run:
    shell: bash

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    env:
      HUGO_VERSION: 0.111.3
    steps:
      - name: Install Hugo CLI
        run: |
          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
          && sudo dpkg -i ${{ runner.temp }}/hugo.deb          
      - name: Install Dart Sass Embedded
        run: sudo snap install dart-sass-embedded
      - name: Checkout
        uses: actions/checkout@v3
        with:
          submodules: recursive
          fetch-depth: 0
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v3
      - name: Install Node.js dependencies
        run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
      - name: Build with Hugo
        env:
          # For maximum backward compatibility with Hugo modules
          HUGO_ENVIRONMENT: production
          HUGO_ENV: production
        run: |
          hugo \
            --gc \
            --minify \
            --baseURL "${{ steps.pages.outputs.base_url }}/"          
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./public

  # 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@v2

この構成ファイルは、mainブランチにプッシュするか、Actionsタブから手動でワークフローを実行すると、Hugo静的サイトをビルドしてGitHub Pagesにデプロイするワークフローを設定します。

結論

プロジェクトでGitHub Pages設定を構成し、提供されるhugo.yamlワークフロー構成を使用することで、Hugo静的サイトをGitHub Pagesにビルドしてデプロイするプロセスを簡単に自動化できます。GitHub Actionsを利用することで、コンテンツの作成やサイトの更新に集中し、毎回手動でデプロイする必要がなくなります。この設定により、GitHub Actionsによって提供される組み込みのCI/CD機能を利用できるため、開発ワークフローをさらに改善できます。

Source code : https://github.com/hobbyworker/hugo-demo

Demo : https://hobbyworker.me/hugo-demo