peaceiris/actions-gh-pages

これは何？

主な機能

• 01任意の静的サイトのビルド出力ディレクトリを GitHub Pages のブランチにデプロイできます。
• 02GITHUB_TOKEN、SSH デプロイキー、Personal Access Token に対応しています。
• 03別の外部リポジトリにも公開できます。
• 04CNAME ファイル、Jekyll 処理の無効化、デプロイ対象から除外するファイルを設定できます。
• 05既存ファイルを保持するか、コミットが1つだけの orphan ブランチを作成できます。
• 06Linux、macOS、Windows のランナーで動作します。

ユースケース

• main への push のたびに、Hugo や MkDocs のドキュメントサイトを自動公開する。
• CI から Next.js や Nuxt の静的エクスポートを GitHub Pages にデプロイする。
• Personal Access Token を使い、非公開のソースリポジトリから公開サイトを公開する。
• 生成したサイトを定期的に再ビルドしてデプロイする。

クイックスタート

1. 1

   ワークフローファイル .github/workflows/gh-pages.yml を追加し、デフォルトブランチに push します

2. 2

   deploy ステップを使って、ビルド出力ディレクトリを公開します

   uses: peaceiris/actions-gh-pages@v4

使う前に知っておきたいこと

• !GITHUB_TOKEN を使った初回デプロイの前に、リポジトリの Pages 設定を行う必要があります。
• !deploy_key オプションは Windows ランナーでは機能しないため、Windows ランナーではデプロイキーが必要です。

収録されている特集

トピック

よくある質問

actions-gh-pages とは？

ワークフローから静的サイトのビルド成果物を GitHub Pages のブランチにデプロイする GitHub Action。 この GitHub Action は、./public や ./out などのビルド出力ディレクトリの内容を、GitHub Pages で使うブランチ（デフォルトでは gh-pages）に公開します。Hugo、MkDocs、Gatsby、mdBook、Next.js、Nuxt、VuePress など、通常のファイルを生成する静的サイトジェネレーターであれば利用できるため、既存のワークフローでビルド後のステップとしてデプロイ処理を追加できます。

actions-gh-pages は無料で使えますか？ライセンスは？

actions-gh-pages は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

actions-gh-pages は今もメンテナンスされていますか？

活発にメンテナンス中。actions-gh-pages の最終コミットは 2026年11月5日 です。

actions-gh-pages は何に使えますか？

main への push のたびに、Hugo や MkDocs のドキュメントサイトを自動公開する。 CI から Next.js や Nuxt の静的エクスポートを GitHub Pages にデプロイする。 Personal Access Token を使い、非公開のソースリポジトリから公開サイトを公開する。 生成したサイトを定期的に再ビルドしてデプロイする。

actions-gh-pages のインストール方法は？

ワークフローファイル .github/workflows/gh-pages.yml を追加し、デフォルトブランチに push します deploy ステップを使って、ビルド出力ディレクトリを公開します: uses: peaceiris/actions-gh-pages@v4

actions-gh-pages はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/peaceiris/actions-gh-pages