Search code examples
githubjekyllgithub-pages

How do I check the deploy status of Github Pages? (Specifically: Project Pages w/ Jekyll)


I have a working Github Page. (Specifically: a Project Page with Jekyll that lives at [username].github.io/[project_name]/.)

I can deploy. (By pushing changes to my gh-pages branch and waiting a few minutes for it to build.)

How can I check the deploy/build status?

It's annoying to wait an unknown number of minutes after I push my changes to Github. I searched for 20 minutes and was surprised to find nothing. Am I misunderstanding something or using the wrong terms? o.O


Solution

  • The easiest thing to do is to go to the commits page for your repo (https://github.com/USERNAME/REPO/commits/master) and there will be a green check mark when it's done building. For example:

    enter image description here

    You can also query the Github API. For example using curl:

    $ curl -u USERNAME https://api.github.com/repos/USERNAME/REPO/pages/builds/latest
    
    {
      "url": "https://api.github.com/repos/USERNAME/REPO/pages/builds/12345678",
      "status": "built",
      ...
    "created_at": "2018-07-26T17:23:42Z"
    

    https://developer.github.com/v3/repos/pages/#get-latest-pages-build

    Some example statuses you might see:

    • queued
    • building
    • built
    • error