peaceiris/actions-gh-pages

Что это?

Ключевые возможности

• 01Публикует содержимое любого каталога со статической сборкой в ветку GitHub Pages.
• 02Поддерживает GITHUB_TOKEN, SSH deploy keys и personal access tokens.
• 03Может публиковать сайт в отдельный внешний репозиторий.
• 04Позволяет добавлять файлы CNAME, отключать обработку Jekyll и исключать файлы из публикации.
• 05Может сохранять существующие файлы или создавать orphan-ветку с одним коммитом.
• 06Работает на раннерах Linux, macOS и Windows.

Сценарии использования

• Автоматическая публикация документации на Hugo или MkDocs при каждом push в main.
• Публикация статического экспорта Next.js или Nuxt в GitHub Pages из CI.
• Публикация публичного сайта из приватного исходного репозитория с помощью personal access token.
• Регулярный запуск сборки и публикации сгенерированного сайта по расписанию.

Быстрый старт

1. 1

   Добавьте файл workflow .github/workflows/gh-pages.yml и отправьте его в ветку по умолчанию

2. 2

   Используйте шаг deploy, чтобы опубликовать каталог с результатами сборки

   uses: peaceiris/actions-gh-pages@v4

Что важно знать

• !Перед первым развертыванием с помощью GITHUB_TOKEN необходимо настроить параметры Pages репозитория.
• !Для раннеров Windows нужны ключи развертывания, поскольку параметр deploy_key в них не работает.

В подборках

Темы

Частые вопросы

Что такое actions-gh-pages?

GitHub Action для публикации собранного статического сайта в ветку GitHub Pages из workflow. Этот GitHub Action публикует содержимое каталога со сборкой, например ./public или ./out, в ветку, используемую GitHub Pages; по умолчанию это gh-pages. Он работает с любым генератором статических сайтов, создающим обычные файлы, включая Hugo, MkDocs, Gatsby, mdBook, Next.js, Nuxt и VuePress. Поэтому шаг публикации можно добавить в существующий workflow сразу после шага сборки.

actions-gh-pages можно использовать бесплатно? Какая у него лицензия?

actions-gh-pages распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

actions-gh-pages всё ещё поддерживается?

Активно поддерживается. Последний коммит в actions-gh-pages — 6 нояб. 2026 г..

Для чего можно использовать actions-gh-pages?

Автоматическая публикация документации на Hugo или MkDocs при каждом push в main. Публикация статического экспорта Next.js или Nuxt в GitHub Pages из CI. Публикация публичного сайта из приватного исходного репозитория с помощью personal access token. Регулярный запуск сборки и публикации сгенерированного сайта по расписанию.

Как установить actions-gh-pages?

Добавьте файл workflow .github/workflows/gh-pages.yml и отправьте его в ветку по умолчанию Используйте шаг deploy, чтобы опубликовать каталог с результатами сборки: uses: peaceiris/actions-gh-pages@v4

Где скачать actions-gh-pages?

Исходный код и инструкции по установке — на GitHub: https://github.com/peaceiris/actions-gh-pages