Article version: GitHub.com

About Jekyll build errors for GitHub Pages sites

If Jekyll encounters an error building your GitHub Pages site locally or on GitHub, you'll receive an error message with more information.

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

In this article

About Jekyll build errors

Sometimes, GitHub Pages will not attempt to build your site after you push changes to your site's publishing source.

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

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.

For more information about troubleshooting build errors, see "Troubleshooting Jekyll build errors for GitHub Pages 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. For more information, see "Testing your GitHub Pages site locally with Jekyll."

When you create a pull request to update your publishing source on GitHub, 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, GitHub Pages 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.

You can see build failures (but not build warnings) for your site on GitHub 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
    rvm:
      - 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.

Ask a human

Can't find what you're looking for?

Contact us