Repolode
Enviar
JamesIves

JamesIves/github-pages-deploy-action

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.

Ver en GitHubSitio web
Estrellas
4,613
Forks
447
Issues abiertos
6
Último commit
hace 4 días

¿Qué es?

GitHub Pages Deploy Action es un paso de GitHub Actions que publica en GitHub Pages una carpeta de tu workflow, como un directorio con los archivos generados durante la compilación. Puedes elegir la rama de destino, incluida gh-pages o docs, y la action crea esa rama si aún no existe. También permite publicar en otros repositorios y funciona con GitHub Enterprise.

La action se configura en la sección `with` de un archivo de workflow. El único parámetro obligatorio es `folder`, que especifica el directorio que se va a publicar. Entre los parámetros opcionales están la rama de destino, el mensaje del commit, el autor de Git, los tokens personalizados o las claves SSH para el despliegue, y la opción de eliminar archivos obsoletos de la rama de despliegue. También permite ejecutar una simulación, condensar el historial en un único commit y exponer una salida `deployment-status` para usar en pasos posteriores.

Está pensado para sitios estáticos y otros proyectos cuyos archivos generados puedan servirse desde una rama. De forma predeterminada, la action se ejecuta en Ubuntu y necesita permiso de escritura sobre el contenido del repositorio.

Funciones clave

  • 01Publica cualquier carpeta en cualquier rama, incluidas gh-pages y docs.
  • 02Permite publicar en otros repositorios mediante un personal access token.
  • 03Se autentica con el GITHUB_TOKEN predeterminado, un PAT o una clave SSH para el despliegue.
  • 04Elimina archivos obsoletos de la rama de despliegue y conserva los archivos excluidos.
  • 05Ofrece un modo de simulación, un historial de un único commit y una salida deployment-status.

Casos de uso

  • Publicar en GitHub Pages, tras cada push, un sitio estático creado con un framework como React o Vue.
  • Desplegar en una rama docs la documentación generada por una herramienta de compilación.
  • Enviar los archivos generados durante la compilación desde un repositorio al sitio Pages de otro repositorio.
  • Desplegar desde un trabajo de compilación de Windows pasando los artefactos a un trabajo de despliegue en Ubuntu.

Inicio rápido

  1. 1

    Añade un archivo workflow que haga checkout del repositorio, compile el sitio y lo despliegue con la action

  2. 2

    Configura los permisos del workflow como contents: write e indica en folder la ruta de salida de la compilación

  3. 3

    En la configuración del repositorio, elige Pages, luego Deploy from a Branch y selecciona la rama de despliegue (normalmente gh-pages)

En colecciones

Frameworks de pruebas y herramientas de automatizaciónGeneradores de sitios estáticos y herramientas de documentación

Temas

#github-actions#github-pages#deployment#ci-cd#static-site#continuous-deployment#action#actions#cicd#continuous-delivery

Preguntas frecuentes

¿Qué es github-pages-deploy-action?
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. GitHub Pages Deploy Action es un paso de GitHub Actions que publica en GitHub Pages una carpeta de tu workflow, como un directorio con los archivos generados durante la compilación. Puedes elegir la rama de destino, incluida gh-pages o docs, y la action crea esa rama si aún no existe. También permite publicar en otros repositorios y funciona con GitHub Enterprise.
¿github-pages-deploy-action es gratuito? ¿Qué licencia tiene?
github-pages-deploy-action es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿github-pages-deploy-action sigue mantenido?
Mantenimiento activo. El último commit de github-pages-deploy-action fue el 2 nov 2026.
¿Para qué puedo usar github-pages-deploy-action?
Publicar en GitHub Pages, tras cada push, un sitio estático creado con un framework como React o Vue. Desplegar en una rama docs la documentación generada por una herramienta de compilación. Enviar los archivos generados durante la compilación desde un repositorio al sitio Pages de otro repositorio. Desplegar desde un trabajo de compilación de Windows pasando los artefactos a un trabajo de despliegue en Ubuntu.
¿Cómo se instala github-pages-deploy-action?
Añade un archivo workflow que haga checkout del repositorio, compile el sitio y lo despliegue con la action Configura los permisos del workflow como contents: write e indica en folder la ruta de salida de la compilación En la configuración del repositorio, elige Pages, luego Deploy from a Branch y selecciona la rama de despliegue (normalmente gh-pages)
¿Dónde consigo github-pages-deploy-action?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/JamesIves/github-pages-deploy-action

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados