Sobre erros de build do Jekyll para sites do GitHub Pages

Sobre erros de construção do Jekyll

Se você estiver publicando a partir de um branch, às vezes GitHub Pages não tentará compilar o seu site depois que você fizer push das alterações para a origem de publicação do seu site.

• Você está fazendo push com uma chave de implantação. Se desejar automatizar pushes para o repositório do seu site, você poderá configurar um usuário de máquina. Para saber mais, confira Gerenciar chaves de implantação.
• Você está usando um serviço de CI que não está configurado para criar sua fonte de publicação. Por exemplo, o Travis CI não compilará o branch gh-pages a menos que você adicione o branch a uma lista segura. Para obter mais informações, confira Como personalizar o build no Travis CI ou na documentação do serviço de CI.

Se o Jekyll tentar criar seu site e encontrar um erro, você receberá uma mensagem de erro de build. Existem dois tipos principais de mensagens de erro de compilação do Jekyll.

• A mensagem "Page build warning" indica que sua criação foi concluída com êxito, mas talvez você precise fazer alterações para evitar problemas futuros.
• A mensagem "Page build failed" indica que sua criação falhou ao ser concluída. Se for possível para o Jekyll detectar um motivo para a falha, você verá uma mensagem de erro descritiva.

Para obter mais informações sobre como solucionar problemas de erros de build, confira Resolução de erros de build do Jekyll para sites do GitHub Pages.

Visualizando as falhas de compilação do seu repositório no GitHub

Você pode visualizar as falhas de compilação (mas não os avisos de compilação) do seu site na aba Configurações do repositório do seu site.

Exibindo mensagens de erro de compilação do Jekyll localmente

É recomendável testar seu site localmente, o que permite que você veja mensagens de erro de build na linha de comando e resolva quaisquer falhas de build antes de enviar alterações por push para GitHub. Para saber mais, confira Testando seu site de páginas GitHub localmente com o Jekyll.

Visualizando mensagens de erro de build do Jekyll em seu pull request

Se você estiver publicando a partir de uma branch, ao criar um pull request para atualizar sua origem de publicação em GitHub, poderá ver mensagens de erro de build na aba Checks do pull request. Para saber mais, confira Sobre verificações de status.

Se você estiver publicando com um fluxo de trabalho personalizado GitHub Actions, para ver as mensagens de erro de compilação no seu pull request, deverá configurar seu fluxo de trabalho para que seja executado pelo acionador pull_request. Ao fazer isso, recomendamos ignorar todas as etapas de implantação se o fluxo de trabalho tiver sido disparado pelo evento pull_request. Isso permitirá que você veja erros de build sem implantar as alterações da sua solicitação de pull em seu site. Para saber mais, confira Eventos que disparam fluxos de trabalho e Avaliar expressões em fluxos de trabalho e ações.

Visualizando os erros de criação do Jekyll por e-mail

Se você estiver publicando a partir de uma branch, ao enviar alterações para sua origem de publicação em GitHub, GitHub Pages tentará compilar seu site. Se a criação falhar, você receberá um e-mail no seu endereço de e-mail principal.

Se você estiver publicando usando um fluxo de trabalho personalizado GitHub Actions, para receber e-mails sobre erros de build em seu pull request, deverá configurar seu fluxo de trabalho para ser executado com o gatilho pull_request. Ao fazer isso, recomendamos ignorar todas as etapas de implantação se o fluxo de trabalho tiver sido disparado pelo evento pull_request. Isso permitirá que você veja erros de build sem implantar as alterações da sua solicitação de pull em seu site. Para saber mais, confira Eventos que disparam fluxos de trabalho e Avaliar expressões em fluxos de trabalho e ações.

Visualizando as mensagens de erro do Jekyll no seu pull request com um serviço de CI de terceiros

Você pode configurar um serviço de terceiros, como o Travis CI, para ver as mensagens de erro após cada commit.

1. Caso ainda não tenha feito isso, adicione um arquivo chamado Gemfile na raiz da fonte de publicação, com o seguinte conteúdo:

   source `https://rubygems.org`
   gem `github-pages`
   

2. Configure o repositório do site para o serviço de teste de sua escolha. Por exemplo, para usar o Travis CI, adicione um arquivo chamado .travis.yml na raiz da fonte de publicação, com o seguinte conteúdo:

   language: ruby
   rvm:
     - 2.3
   script: "bundle exec jekyll build"
   

3. Talvez você precise ativar o repositório com o serviço de teste de terceiros. Para obter mais informações, consulte a documentação do seu serviço de teste.