Saltearse al contenido

Despliega tu proyecto de Astro en GitHub pages

Puedes usar GitHub pages para desplegar tu proyecto de Astro directamente desde un repositorio en GitHub.com.

Cómo desplegar

Sección titulada Cómo desplegar

Puedes desplegar un proyecto de Astro en GitHub Pages usando GitHub Actions para construir y desplegar tu proyecto automáticamente. Para hacer esto, tu código fuente debe estar alojado en GitHub.

Astro mantiene la acción oficial withastro/action para desplegar tu proyecto con muy poca configuración. Sigue las instrucciones a continuación para desplegar tu proyecto de Astro en GitHub Pages y consulta el README si necesitas más información.

  1. Configura las opciones site y, si es necesario, base en astro.config.mjs.

    astro.config.mjs
    import { defineConfig } from 'astro/config'
    

    export default defineConfig({
      site: 'https://astronaut.github.io',
      base: '/mi-repo',
    })
    • site debe ser https://<TU_NOMBRE_DE_USUARIO>.github.io o https://mi-dominio.com
    • base debe ser el nombre de tu repositorio comenzando con una barra diagonal, por ejemplo /mi-repo. Esto es para que Astro entienda que el root de tu sitio web es /mi-repo, en lugar de / que es el valor por defecto.

  2. Crea un nuevo archivo en tu proyecto en .github/workflows/deploy.yml, dentro del mismo copia y pega el siguiente código YAML.

    deploy.yml
    name: GitHub Pages Astro CI
    

    on:
      # Activa el workflow cada vez que hay un push a la rama `main`
      # ¿Estás usando un nombre diferente de rama? Reemplaza `main` con el nombre de tu rama
      push:
        branches: [ main ]
      # Te permite ejecutar este workflow manualmente desde la pestaña Actions en GitHub.
      workflow_dispatch:
    

    # Permite clonar el repositorio y desplegar el proyecto
    permissions:
      contents: read
      pages: write
      id-token: write
    

    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - name: Checkout your repository using git
            uses: actions/checkout@v3
          - name: Install, build, and upload your site
            uses: withastro/action@v1
            # with:
              # path: . # La ubicación de la raíz de tu proyecto de Astro dentro del repositorio. (opcional)
              # node-version: 18 # La versión específica de Node que debe utilizarse para compilar tu proyecto. Por defecto es la 18. (opcional)
              # package-manager: pnpm@latest # El gestor de paquetes de Node que debe instalar las dependencias y compilar tu proyecto. Automáticamente detectadas con base en tu archivo lockfile. (opcional)
    

    

      deploy:
        needs: build
        runs-on: ubuntu-latest
        environment:
          name: github-pages
          url: ${{ steps.deployment.outputs.page_url }}
        steps:
          - name: Deploy to GitHub Pages
            id: deployment
            uses: actions/deploy-pages@v1

  3. En GitHub, ve a la pestaña Settings de tu repositorio y busca la sección Pages.

  4. Elige GitHub Actions como el Source de tu proyecto.

  5. Has commit del nuevo archivo workflow y has push a GitHub.

¡Tu proyecto debería estar publicado! Cuando haya cambios en tu repositorio, GitHub Action los implementará automáticamente por ti.

Más guías de implementación

Filtrar por tipo de implementación