Sobre erros de criação do Jekyll para sites do GitHub Pages

Se o Jekyll encontrar um erro ao criar seu site do GitHub Pages localmente ou no GitHub Enterprise Cloud, você receberá uma mensagem de erro com mais informações.

Quem pode usar esse recurso?

O GitHub Pages está disponível em repositórios públicos com o GitHub Free e o GitHub Free para organizações, e em repositórios públicos e privados com o GitHub Pro, o GitHub Team, o GitHub Enterprise Cloud e o GitHub Enterprise Server. Para mais informações, confira "Planos do GitHub".

O GitHub Pages agora usa o GitHub Actions para executar a compilação Jekyll. Ao usar uma ramificação como a origem da sua compilação, o GitHub Actions deverá estar habilitado em seu repositório se você quiser usar o fluxo de trabalho interno do Jekyll. Como alternativa, se o GitHub Actions não estiver disponível ou estiver desabilitado, adicionar um .nojekyll arquivo à raiz da ramificação de origem ignorará o processo de compilação do Jekyll e implantará o conteúdo diretamente. Para mais informações sobre ativar o GitHub Actions, confira "Gerenciando as configurações do GitHub Actions para um repositório".

Neste artigo

Sobre erros de criação do Jekyll

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

  • A pessoa que fez push das alterações não verificou o endereço de e-mail dela. Para saber mais, confira Verificar endereço de e-mail.
  • 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.

Note

Poderá levar até 10 minutos para que as alterações no seu site sejam publicadas depois que você efetuar push das alterações para o GitHub Enterprise Cloud.

Se o Jekyll não tentar criar seu site e encontrar um erro, você receberá uma mensagem de erro de criação.

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

Visualizando as mensagens de erro de criação do Jekyll com GitHub Actions

Por padrão, seu site de GitHub Pages foi criado e implantado com a execução de um fluxo de trabalho de GitHub Actions, a menos que você tenha configurado seu site do GitHub Pages para usar uma ferramenta de CI diferente. Para encontrar possíveis erros de criação, verifique a execução do fluxo de trabalho para o seu site do GitHub Pages, revisando a execução do fluxo de trabalho do seu repositório. Para saber mais, confira Visualizar o histórico de execução do fluxo de trabalho. Para obter mais informações sobre como executar novamente o fluxo de trabalho em caso de erro, confira Reexecutando fluxos de trabalho e trabalhos.

Visualizando as mensagens de erro de criação do Jekyll localmente

É recomendável testar o site no local, o que permite ver mensagens de erro de criação na linha de comando e solucionar qualquer falha de criação antes de fazer push das alterações no GitHub Enterprise Cloud. Para saber mais, confira Testar o site do GitHub Pages localmente com o Jekyll.

Visualizando mensagens de erro de criação do Jekyll no seu pull request

Ao publicar a partir de um branch, quando criar um pull request para atualizar sua fonte de publicação em GitHub Enterprise Cloud, você poderá ver mensagens de erro de build na guia Verificações do pull request. Para saber mais, confira Sobre verificações de status.

Se você estiver publicando com um fluxo de trabalho personalizado de GitHub Actions, para ver as mensagens de erro de build na sua pull request, você precisará configurar seu fluxo de trabalho para ser executado no pull_request gatilho. 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 de um branch, quando você efetuar push das alterações para sua fonte de publicação em GitHub Enterprise Cloud, GitHub Pages tentará criar seu site. Se a criação falhar, você receberá um e-mail no seu endereço de e-mail principal.

Se você estiver publicando com um fluxo de trabalho personalizado de GitHub Actions, para receber e-mails sobre o erro de build em seu pull request, você precisará configurar seu fluxo de trabalho para ser executado no 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.