About Jekyll build errors for GitHub Pages sites

If Jekyll encounters an error building your Páginas de GitHub site locally or on GitHub Enterprise, you'll receive an error message with more information.

Páginas de GitHub se encuentra disponible en repositorios públicos con GitHub Free y GitHub Free para organizaciones, y en repositorios privados y públicos con GitHub Pro, GitHub Team, GitHub Enterprise Cloud, y Servidor de GitHub Enterprise.

About Jekyll build errors

Sometimes, Páginas de GitHub will not attempt to build your site after you push changes to your site's publishing source.

  • You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "Managing deploy keys."
  • You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the gh-pages branch unless you add the branch to a safe list. For more information, see "Customizing the build" on Travis CI, or your CI service's documentation.

Note: It can take up to 20 minutes for changes to your site to publish after you push the changes to GitHub Enterprise.

If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. There are two main types of Jekyll build error messages.

  • A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems.
  • A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message.

For more information about troubleshooting build errors, see "Troubleshooting Jekyll build errors for Páginas de GitHub sites."

Viewing Jekyll build error messages

We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to GitHub Enterprise. For more information, see "Testing your Páginas de GitHub site locally with Jekyll."

When you create a pull request to update your publishing source on GitHub Enterprise, you can see build error messages on the Checks tab of the pull request. For more information, see "About status checks."

When you push changes to your publishing source on GitHub Enterprise, Páginas de GitHub will attempt to build your site. If the build fails, you'll receive an email at your primary email address. You'll also receive emails for build warnings.

Solo recibiras un correo electrónico si habilitas la compatibilidad con correo externo en tu instancia de servidor de GitHub Enterprise. Para obtener más información, contacta a tu administrador de sitio.

You can see build failures (but not build warnings) for your site on GitHub Enterprise in the Settings tab of your site's repository.

You can configure a third-party service, such as Travis CI, to display error messages after each commit.

  1. If you haven't already, add a file called Gemfile in the root of your publishing source, with the following content:

    source `https://rubygems.org`
    gem `github-pages`
  2. Configure your site's repository for the testing service of your choice. For example, to use Travis CI, add a file named .travis.yml in the root of your publishing source, with the following content:

    language: ruby
      - 2.3
    script: "bundle exec jekyll build"
  3. You may need to activate your repository with the third-party testing service. For more information, see your testing service's documentation.

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.