JamesIves/github-pages-deploy-action

これは何？

主な機能

• 01gh-pagesやdocsを含む、任意のフォルダを任意のブランチにデプロイできます。
• 02Personal Access Tokenを使った、リポジトリをまたぐデプロイに対応しています。
• 03デフォルトのGITHUB_TOKEN、PAT、SSH deploy keyで認証できます。
• 04除外したファイルを残しながら、デプロイブランチの古いファイルを削除できます。
• 05dry-runモード、単一コミットの履歴、deployment-status出力を利用できます。

ユースケース

• pushのたびに、ReactやVueなどのフレームワークでビルドした静的サイトをGitHub Pagesに公開する。
• ビルドツールで生成したドキュメントをdocsブランチにデプロイする。
• あるリポジトリのビルド成果物を、別のリポジトリのPagesサイトにpushする。
• Windowsのビルドジョブから成果物をUbuntuのデプロイジョブに渡してデプロイする。

クイックスタート

1. 1

   リポジトリをチェックアウトし、サイトをビルドして、action でデプロイする workflow ファイルを追加します

2. 2

   workflow の permissions を contents: write に設定し、folder にビルド出力先を指定します

3. 3

   リポジトリの設定で Pages を選び、次に Deploy from a Branch を選択して、デプロイするブランチ（通常は gh-pages）を選びます

収録されている特集

トピック

よくある質問

github-pages-deploy-action とは？

プロジェクトを自動でビルドしてGitHub Pagesにデプロイし、出力をgh-pagesやdocsなど任意のブランチにpushするGitHub Actions。 GitHub Pages Deploy Actionは、ビルド出力ディレクトリなど、ワークフロー内のフォルダをGitHub Pagesに公開するGitHub Actionsのステップです。gh-pagesやdocsなど、デプロイ先のブランチを指定でき、ブランチがまだ存在しない場合はアクションが作成します。リポジトリをまたいだデプロイにも対応し、GitHub Enterpriseでも利用できます。

github-pages-deploy-action は無料で使えますか？ライセンスは？

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

github-pages-deploy-action は今もメンテナンスされていますか？

活発にメンテナンス中。github-pages-deploy-action の最終コミットは 2026年11月2日 です。

github-pages-deploy-action は何に使えますか？

pushのたびに、ReactやVueなどのフレームワークでビルドした静的サイトをGitHub Pagesに公開する。 ビルドツールで生成したドキュメントをdocsブランチにデプロイする。 あるリポジトリのビルド成果物を、別のリポジトリのPagesサイトにpushする。 Windowsのビルドジョブから成果物をUbuntuのデプロイジョブに渡してデプロイする。

github-pages-deploy-action のインストール方法は？

リポジトリをチェックアウトし、サイトをビルドして、action でデプロイする workflow ファイルを追加します workflow の permissions を contents: write に設定し、folder にビルド出力先を指定します リポジトリの設定で Pages を選び、次に Deploy from a Branch を選択して、デプロイするブランチ（通常は gh-pages）を選びます

github-pages-deploy-action はどこで入手できますか？

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