Una GitHub Actions action que compila y publica automáticamente tu proyecto en GitHub Pages, y envía los archivos generados a cualquier rama, como gh-pages o docs.
4,6 mil447TypeScriptMITActualizado hace 5 días
peaceiris/actions-gh-pages
Una GitHub Action que publica el resultado de compilación de un sitio estático en una rama de GitHub Pages desde tu workflow.
- Estrellas
- 5,369
- Forks
- 448
- Issues abiertos
- 95
- Último commit
- hace 20 horas
¿Qué es?
Esta GitHub Action publica el contenido de un directorio de resultados de compilación, como ./public o ./out, en una rama que usa GitHub Pages; de forma predeterminada, gh-pages. Funciona con cualquier generador de sitios estáticos que produzca archivos sin formato, incluidos Hugo, MkDocs, Gatsby, mdBook, Next.js, Nuxt y VuePress, por lo que puedes agregar el paso de despliegue después del paso de compilación en un workflow existente.
La autenticación puede usar el GITHUB_TOKEN creado automáticamente para el repositorio actual, una clave de despliegue SSH o un personal access token. Se necesita el token personal o la clave de despliegue para publicar en otro repositorio mediante la opción external_repository. Otras opciones permiten configurar la rama de destino y un subdirectorio de destino, excluir archivos, agregar un archivo CNAME, controlar el procesamiento de Jekyll, conservar los archivos existentes, crear ramas huérfanas con force, definir el autor y el mensaje del commit, y crear Git tags.
La action se ejecuta en runners de Linux, macOS y Windows, y es compatible con GitHub Enterprise Server a partir de la versión 2.22.6.
Funciones clave
- 01Publica cualquier directorio de resultados de compilación de un sitio estático en una rama de GitHub Pages.
- 02Admite GITHUB_TOKEN, claves de despliegue SSH y personal access tokens.
- 03Puede publicar en un repositorio externo independiente.
- 04Incluye opciones para archivos CNAME, omitir el procesamiento de Jekyll y excluir archivos del despliegue.
- 05Puede conservar los archivos existentes o crear una rama huérfana con un solo commit.
- 06Se ejecuta en runners de Linux, macOS y Windows.
Casos de uso
- Publicar automáticamente un sitio de documentación de Hugo o MkDocs con cada push a main.
- Desplegar una exportación estática de Next.js o Nuxt en GitHub Pages desde CI.
- Publicar un sitio público desde un repositorio de código fuente privado mediante un personal access token.
- Programar compilaciones y despliegues periódicos de un sitio generado.
Inicio rápido
- 1
Añade el archivo de workflow .github/workflows/gh-pages.yml y haz push a la rama predeterminada
- 2
Usa el paso deploy para publicar el directorio de salida de la compilación
uses: peaceiris/actions-gh-pages@v4
Antes de usarlo
- Es necesario configurar los ajustes de Pages del repositorio antes del primer despliegue con GITHUB_TOKEN.
- Se necesitan claves de despliegue para los runners de Windows, ya que la opción deploy_key no funciona en ellos.
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es actions-gh-pages?
- Una GitHub Action que publica el resultado de compilación de un sitio estático en una rama de GitHub Pages desde tu workflow. Esta GitHub Action publica el contenido de un directorio de resultados de compilación, como ./public o ./out, en una rama que usa GitHub Pages; de forma predeterminada, gh-pages. Funciona con cualquier generador de sitios estáticos que produzca archivos sin formato, incluidos Hugo, MkDocs, Gatsby, mdBook, Next.js, Nuxt y VuePress, por lo que puedes agregar el paso de despliegue después del paso de compilación en un workflow existente.
- ¿actions-gh-pages es gratuito? ¿Qué licencia tiene?
- actions-gh-pages es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿actions-gh-pages sigue mantenido?
- Mantenimiento activo. El último commit de actions-gh-pages fue el 6 nov 2026.
- ¿Para qué puedo usar actions-gh-pages?
- Publicar automáticamente un sitio de documentación de Hugo o MkDocs con cada push a main. Desplegar una exportación estática de Next.js o Nuxt en GitHub Pages desde CI. Publicar un sitio público desde un repositorio de código fuente privado mediante un personal access token. Programar compilaciones y despliegues periódicos de un sitio generado.
- ¿Cómo se instala actions-gh-pages?
- Añade el archivo de workflow .github/workflows/gh-pages.yml y haz push a la rama predeterminada Usa el paso deploy para publicar el directorio de salida de la compilación: uses: peaceiris/actions-gh-pages@v4
- ¿Dónde consigo actions-gh-pages?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/peaceiris/actions-gh-pages
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Agente de seguridad para CI/CD en runners de GitHub Actions que supervisa el tráfico de red saliente, las escrituras de archivos y la actividad de procesos para detectar ataques a la cadena de suministro.
1,3 mil+3 esta semana126TypeScriptApache-2.0Actualizado hace 22 horas
Una GitHub Action para ejecutar comandos en servidores remotos por SSH desde tus flujos de CI/CD.
6,2 mil+5 esta semana677ShellMITActualizado hace 3 meses
Framework open source de Hugo con bloques Tailwind para crear landing pages, portfolios, blogs y documentación a partir de archivos Markdown sin formato.
9,8 mil+10 esta semana3 milHTMLMITActualizado hace 3 meses
Plugin de WordPress que exporta con un clic publicaciones, páginas, metadatos y ajustes a Markdown y YAML para Jekyll, Hugo u otros generadores de sitios estáticos.
1,1 mil+1 esta semana130PHPGPL-3.0Actualizado hace 22 horas
Extensión de GitHub CLI que permite definir automatizaciones de repositorio con IA en Markdown y ejecutarlas de forma segura mediante GitHub Actions.
5,6 mil+51 esta semana619GoMITActualizado hace 19 horas