peaceiris/actions-gh-pages

GitHub Pages へのデプロイを自動化する GitHub Actions。静的サイトジェネレーターと組み合わせて使用できます。

インストール型ツール自由に使える · MITWeb・Next.js・フルスタックTypeScript難易度
5,3650 保存
448フォーク59Issue

中辛 の解説

TypeScript で実装された GitHub Actions です。publish_dir で指定したディレクトリの内容を gh-pages ブランチ(またはカスタムブランチ)にデプロイします。GITHUB_TOKEN、SSH デプロイキー、パーソナルアクセストークンの 3 つの認証方式に対応し、Linux・macOS・Windows で動作します。複数のジェネレーター(Hugo、MkDocs、mdBook、Next.js、Nuxt など)の実装例が README に含まれています。

こんなリポジトリです

こんなときに便利です

  • Hugo・MkDocs・Next.js などで生成した静的サイトを GitHub Pages に自動デプロイする
  • プルリクエスト時に一時的なプレビューサイトをデプロイして検証する
  • ドキュメントサイト(Docusaurus・mdBook など)の更新を自動で反映させる

主な機能

複数認証方式対応(GITHUB_TOKEN・SSH・PAT)各種静的サイトジェネレーターとの統合例が豊富外部リポジトリへのデプロイ・サブディレクトリ指定・アセット除外などのオプション

ほかとの違い

GitHub 公式の GitHub Pages Action よりも静的サイトジェネレーターとの統合例が充実しており、フレキシブルな認証方式と外部リポジトリへのデプロイに対応している点が特徴です。

このリポジトリの作り方

はじめてですか? むずかしくありません — 上から順にたどれば、自分の環境で動かして味見できます。

準備するもの

  • GitHub リポジトリ
  • GitHub Actions の有効化
  • デプロイ対象の静的ファイル生成スクリプト

すぐに始める

  1. リポジトリの .github/workflows/gh-pages.yml ファイルを作成します。
mkdir -p .github/workflows
touch .github/workflows/gh-pages.yml
  1. ワークフローファイルに以下の設定を追加します(Hugo の例)。
name: GitHub Pages

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  deploy:
    runs-on: ubuntu-22.04
    permissions:
      contents: write
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true
          fetch-depth: 0

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: '0.110.0'

      - name: Build
        run: hugo --minify

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        if: github.ref == 'refs/heads/main'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./public
  1. リポジトリの設定ページで GitHub Pages をデプロイブランチとして gh-pages を選択します。

  2. gh-pages.yml を Git にコミット・プッシュします。

git add .github/workflows/gh-pages.yml
git commit -m "Add GitHub Pages deployment workflow"
git push origin main
  1. ワークフローが実行され、完了すると GitHub Pages に自動でデプロイされます。

ギット飯トライで味見

入れるのが面倒で少し不安だったなら — 安全スキャンからインストールまで、ターミナル一行で終わります。

ターミナルに貼り付ければ、ギット飯の安全スキャン → 隔離フォルダへ clone → インストール → 実行方法の案内まで自動です。はじめてでも大丈夫 — この一行だけです。

npx gitbap-try peaceiris/actions-gh-pages

Node.js さえあれば、インストールなしで動きます · ギット飯トライとは? →

スター推移 · 7日

5,3657日間の増加数を計算するための比較データが不足しています

確認日時

使いやすさ · まねしやすいか

まねしやすいサンプル評点 46/100
  • ゆるいライセンス
  • テストあり
  • サンプル集
  • 最近の更新
  • AGENTS.md
  • llms.txt
  • テンプレート

最近の更新あり · 2019 年に作成

「Web・Next.js・フルスタック」 こういうリポジトリを毎週受け取りませんか?

毎週月曜の朝、選んだ一膳だけ。広告なし · いつでも解除。

自分のリポジトリですか? README にギット飯バッジを貼る
[![깃밥](https://www.gitbap.com/badge/peaceiris/actions-gh-pages.svg)](https://www.gitbap.com/r/peaceiris/actions-gh-pages)
Claude からそのまま使う — ギット飯のつなぎ方

ギット飯を Claude につなぐと、こうしたリポジトリを Claude・Cursor・Codex から直接さがして試せます。

方法 ① コネクタ URL

Claude の設定 → コネクタにこのアドレスを貼り付け。

https://www.gitbap.com/api/mcp
方法 ② プラグイン(試用まで)

プラグインを入れると /gitbap-trending·/gitbap-try のスラッシュコマンドで、その場でリポジトリを試せます。Claude Code で下の 2 行を順に実行してください。

/plugin marketplace add jakeparkcolde/gitbap-cowork
/plugin install gitbap-cowork@gitbap
つなぎ方をくわしく →

AI が README をもとに要約しました · 原文を見る