docC github pages deploy

Implementación de DocC Github Pages: Implemente el sitio estático DocC generado en Github-Pages.

• Requisitos
• Uso
• Integración
• Colaboradores
• Licencia

Requisitos

Plataforma	Estado
ubuntu-último	Probado

Uso

Ver acción.yml.

Asegúrese de configurar la versión con la etiqueta más reciente.

Como ejemplo:

 name : worksapce
on :
  push :
    branches :
      - ' ** '
jobs :
  build_deploy_site :
    runs-on : ubuntu-latest
    environment :
      name : github-pages
      url : ${{ steps.deployment.outputs.page_url }}

    permissions :
      pages : write
      contents : read
      id-token : write

    steps :
    - name : deploy static site
      uses : kiarashvosough1999/[email protected]

Asegúrese de otorgar acceso a pages , contents y id-token , o la acción no logrará insertar el sitio en Github-Pages.

Asegúrese de especificar el name y url en el entorno como en el ejemplo, o el trabajo fallará.

Integración con el sitio estático Build DocC

Puede utilizar build-docC-static-site para generar un sitio estático desde DocC Archive.

El docC-generated-static-site-uploaded-name predeterminado asociado con el sitio estático build-docC y docC-generated-static-site-zipped-upload-name asociado con esta acción, la entrada debe ser la misma.

Esta acción descomprimirá el sitio estático de entrada con la extensión gtar y tar . Por lo tanto, no especifique la extensión zip ni en docC-generated-static-site-uploaded-name ni en docC-generated-static-site-zipped-upload-name name .

Colaboradores

No dudes en compartir tus ideas o cualquier otro problema. Las solicitudes de extracción son bienvenidas.

Licencia

docC-github-pages-deploy se publica bajo una licencia del MIT. Consulte LICENCIA para obtener más información.