Sometimes, GitHub Pages will not attempt to build your site after you push changes to your site's publishing source.
- The person who pushed the changes hasn't verified their email address. For more information, see "Verifying your email address."
- 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-pagesbranch 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.
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 GitHub Pages sites."
By default, your GitHub Pages site is built and deployed with a GitHub Actions workflow run unless you've configured your GitHub Pages site to use a different CI tool. To find potential build errors, you can check the workflow run for your GitHub Pages site by reviewing your repository's workflow runs. For more information, see "Viewing workflow run history." For more information about how to re-run the workflow in case of an error, see "Re-running workflows and jobs."
Note: GitHub Actions workflow runs for your GitHub Pages sites are in public beta for public repositories and subject to change. GitHub Actions workflow runs are free for public repositories.
You can see build failures (but not build warnings) for your site on GitHub in the Settings tab of your site's repository.
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 configure a third-party service, such as Travis CI, to display error messages after each commit.
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`
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"
You may need to activate your repository with the third-party testing service. For more information, see your testing service's documentation.