Pular para o conteúdo

Faça o deploy do seu site Astro no GitHub Pages

Você pode usar o GitHub Pages para hospedar o seu site Astro diretamente do seu repositório no GitHub.com.

Como fazer o deploy

Seção intitulada Como fazer o deploy

Você pode fazer o deploy através de GitHub Actions para automaticamente gerar o build e fazer o deploy do seu site. Para isso, o seu código-fonte precisa estar hospedado no GitHub.

O Astro mantém oficialmente o withastro/action para fazer o deploy do seu projeto com pouquíssima configuração. Siga as instruções abaixo para realizar o deploy do seu site Astro no GitHub Pages, e leia o README do pacote se você precisa de mais informações.

  1. Defina as opções de site e, se necessário, base em astro.config.mjs.

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

    export default defineConfig({
      site: 'https://astronaut.github.io',
      base: '/meu-repositorio',
    });
    • site deve ser https://<SEU_NOME_DE_USUARIO>.github.io ou https://meu-dominio-personalizado.com
    • base deve ser o nome do seu repositório após uma barra para frente, por exemplo /meu-repositorio. Isso para que o Astro posso entender que a raiz do seu site está em /meu-repositorio, em vez do padrão /.

  2. Crie um novo arquivo no seu projeto em .github/workflows/deploy.yml e cole o YAML abaixo.

    deploy.yml
    name: GitHub Pages Astro CI
    

    on:
      # Ativa o workflow toda vez que você fizer um push para a branch `main`
      # Usando um nome de branch diferente? Modifique `main` para o nome da sua branch
      push:
        branches: [main]
    # Permite que esse workflow seja executado manualmente da aba "Actions" no GitHub.
      workflow_dispatch:
    

    # Permite que este job clone o repositório e crie uma página de deploy
    permissions:
      contents: read
      pages: write
      id-token: write
    

    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - name: Checkout your repository using git
            uses: actions/checkout@v4
          - name: Install, build, and upload your site
            uses: withastro/action@v1
             # with:
               # path: . # A localização da pasta raiz do seu projeto Astro dentro do seu repositório. (opcional)
               # node-version: 18 # A versão específica do Node que deve ser utilizada para a build do seu site. A versão padrão é a 18. (opcional)
               # package-manager: pnpm@latest # O gerenciador de pacotes usado para instalar as dependências e fazer a build do site. É automaticamente detectado a partir da sua 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. No GitHub, vá para a aba Settings do seu repositório e encontre a seção Pages das configurações.

  4. Escolha GitHub Actions como a Source do seu site.

  5. Faça o commit do novo arquivo de workflow e faça push para o GitHub.

O seu site deve estar publicado agora! Quando você fizer push de mudanças para o repositório do seu projeto Astro, a Action do GitHub irá fazer deploy delas automaticamente para você.

Mais Guias de Deploy

Contribua

O que passa em sua cabeça?

Criar uma Issue no GitHub

A maneira mais rápida de alertar nosso time sobre um problema.

Comunidade