GitHub Action для публикации собранного статического сайта в ветку GitHub Pages из workflow.
JamesIves/github-pages-deploy-action
GitHub Actions для автоматической сборки и публикации проекта на GitHub Pages с отправкой результата в любую ветку, например gh-pages или docs.
- Звёзды
- 4,613
- Форки
- 447
- Открытые issues
- 6
- Последний коммит
- 4 дня назад
Что это?
GitHub Pages Deploy Action — это шаг GitHub Actions, который публикует папку из workflow, например каталог со сборкой, на GitHub Pages. Вы выбираете целевую ветку, в том числе gh-pages или docs; если такой ветки ещё нет, action создаст её. Также поддерживаются публикация в другой репозиторий и GitHub Enterprise.
Action настраивается в секции `with` файла workflow. Единственный обязательный параметр — `folder`, то есть каталог для публикации. Необязательные настройки позволяют указать целевую ветку, сообщение коммита, автора в Git, пользовательские токены или SSH deploy keys, а также выбрать, удалять ли устаревшие файлы из ветки публикации. Кроме того, доступны режим dry-run, объединение истории в один коммит и выходной параметр `deployment-status` для следующих шагов.
Action предназначен для статических сайтов и других проектов, собранные файлы которых можно раздавать из ветки. По умолчанию он выполняется на Ubuntu и требует разрешения на запись содержимого репозитория.
Ключевые возможности
- 01Публикует любую папку в любую ветку, в том числе gh-pages и docs.
- 02Поддерживает публикацию в другой репозиторий с помощью personal access token.
- 03Поддерживает аутентификацию через GITHUB_TOKEN по умолчанию, PAT или SSH deploy key.
- 04Удаляет устаревшие файлы из ветки публикации, сохраняя исключённые файлы.
- 05Предоставляет режим dry-run, историю из одного коммита и выходной параметр deployment-status.
Сценарии использования
- Публикация статического сайта, собранного с помощью фреймворка вроде React или Vue, на GitHub Pages после каждого push.
- Публикация документации, сгенерированной инструментом сборки, в ветку docs.
- Отправка результата сборки из одного репозитория в Pages другого репозитория.
- Публикация из задания сборки на Windows с передачей артефактов в задание публикации на Ubuntu.
Быстрый старт
- 1
Добавьте файл workflow, который выполнит checkout репозитория, соберёт сайт и развернёт его с помощью action
- 2
Установите для permissions в workflow значение contents: write и укажите в folder путь к результатам сборки
- 3
В настройках репозитория выберите Pages, затем Deploy from a Branch и укажите ветку для деплоя (обычно gh-pages)
В подборках
Темы
Частые вопросы
- Что такое github-pages-deploy-action?
- GitHub Actions для автоматической сборки и публикации проекта на GitHub Pages с отправкой результата в любую ветку, например gh-pages или docs. GitHub Pages Deploy Action — это шаг GitHub Actions, который публикует папку из workflow, например каталог со сборкой, на GitHub Pages. Вы выбираете целевую ветку, в том числе gh-pages или docs; если такой ветки ещё нет, action создаст её. Также поддерживаются публикация в другой репозиторий и GitHub Enterprise.
- github-pages-deploy-action можно использовать бесплатно? Какая у него лицензия?
- github-pages-deploy-action распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
- github-pages-deploy-action всё ещё поддерживается?
- Активно поддерживается. Последний коммит в github-pages-deploy-action — 2 нояб. 2026 г..
- Для чего можно использовать github-pages-deploy-action?
- Публикация статического сайта, собранного с помощью фреймворка вроде React или Vue, на GitHub Pages после каждого push. Публикация документации, сгенерированной инструментом сборки, в ветку docs. Отправка результата сборки из одного репозитория в Pages другого репозитория. Публикация из задания сборки на Windows с передачей артефактов в задание публикации на Ubuntu.
- Как установить github-pages-deploy-action?
- Добавьте файл workflow, который выполнит checkout репозитория, соберёт сайт и развернёт его с помощью action Установите для permissions в workflow значение contents: write и укажите в folder путь к результатам сборки В настройках репозитория выберите Pages, затем Deploy from a Branch и укажите ветку для деплоя (обычно gh-pages)
- Где скачать github-pages-deploy-action?
- Исходный код и инструкции по установке — на GitHub: https://github.com/JamesIves/github-pages-deploy-action
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Похожие проекты
Jenkins — сервер автоматизации с открытым исходным кодом для сборки, тестирования и развертывания ПО, расширяемый более чем 2 000 плагинов.
Платформа CI/CD и DevOps-автоматизации на Go для собственного хостинга: workflows объединяют pipelines, jobs и triggers.
GitHub Action для создания GitHub Releases и загрузки артефактов сборки из Linux-, Windows- и macOS-раннеров.
Агент безопасности для CI/CD, который отслеживает исходящие сетевые подключения, запись файлов и активность процессов на раннерах GitHub Actions, чтобы выявлять атаки на цепочки поставок.
GitHub Action для выполнения команд на удалённых серверах по SSH из CI/CD workflow.