ghpages

Acción de GitHub para implementar activos estáticos en páginas de GitHub

Esta acción ha quedado obsoleta. Ahora hay soporte "nativo" para publicar en páginas de GitHub mediante una acción oficial de GitHub de GitHub. Es mucho mejor que este enfoque.

Esta acción simplemente le permite implementar carpetas arbitrarias de contenido estático desde el directorio de trabajo de su flujo de trabajo ( /github/workspace ) en páginas de GitHub. Esto funciona haciendo que su instancia de acción git push la carpeta de activos elegida ( BUILD_DIR ) a la rama gh-pages de su repositorio de GitHub para que se entregue la rama gh-pages . Si está ejecutando esta acción dentro de una organización o repositorio de usuarios (llamado username/username.github.io ), se implementará en la rama master .

Recuerde que es posible que también deba ajustar la configuración de su repositorio.

Debido a que esta acción se implementa en ramas separadas de "solo implementación", no puede usarla si desea implementar desde un subdirectorio de repositorio como docs/ . En esos casos, realmente no necesitas una acción de GitHub, porque tú mismo estarías confirmando los artefactos de compilación. Para obtener más detalles, consulte la documentación de páginas de GitHub.

Ya existen excelentes acciones de GitHub para usar generadores de sitios estáticos y luego implementarlas en páginas de GitHub (para jekyll, jekyll, zola y seguramente muchas más por venir). Esta acción no es eso, aunque he tomado prestada gran parte de la acción git de estos trabajos.

Esta acción no construirá nada, simplemente se implementará.

Entradas

Ninguno.

Salidas

Ninguno.

Misterios

La implementación en las páginas de GitHub se realiza mediante git push a la rama gh-pages (o master ). Para autorizar esto, la acción de GitHub necesita un secreto. Por ahora, de manera algo confusa, el GITHUB_TOKEN disponible para cada repositorio es suficiente para enviar a gh-pages , pero no es suficiente para activar la creación de una página en GitHub, ni siquiera para propagar el contenido a la red de entrega de contenido de GitHub.

Por lo tanto, debe crear un token de acceso personal (PAT) personalizado, muy parecido a lo que haría con los servicios externos (por ejemplo, Travis). Este token debe crearse con permisos repo para poder implementarlo en Github Pages. Luego debe pegar este token en la interfaz de usuario de GitHub como un secreto con el nombre GH_PAT (configuración/secretos del repositorio) y llamarlo en la acción como se muestra a continuación.

Le pedí a GitHub que agilizara este proceso. La discusión está documentada aquí.

Variables de entorno

Simplemente BUILD_DIR , el directorio de compilación relativo a la raíz de su repositorio. También puedes pasar . si desea impulsar la raíz de su repositorio.

Uso de ejemplo

 name : Deployment

" on " :
  - push
  - pull_request

jobs :
  deploy_ghpages :
    runs-on : ubuntu-18.04
    steps :
      - uses : actions/checkout@v1
      - run : echo $GITHUB_SHA >> public/index.html
      - uses : maxheld83/[email protected]
        env :
          BUILD_DIR : public/
          GH_PAT : ${{ secrets.GH_PAT }}