Home  >   Blog  >   Deploying Static Site to GitHub Pages via Travis CI

June 26, 2017 | 2 min read | 355 words

Deploying Static Site to GitHub Pages via Travis CI

As I repeatedly mentioned in this blog, takuti.me is currently generated by Hugo:

Manual deployment

Until quite recently, my deployment workflow was not clever; I manually followed the steps as:

  1. Write an article under takuti.me/_content directory
  2. Hit rake command and generate my site under the public/ directory
  3. Commit & push takuti.me/* to repository (source), except for public/
  4. Commit & push takuti.me/public/* to repository (GitHub Pages)

It actually works, but we can automate the workflow more aggressively...it's 2017!

Utilizing deploy: feature on Travis CI

So, eventually deployment becomes easier thanks to the following guide:

My current .travis.yml looks like:

language: c
os: osx

before_script:
  - npm install -g gulp
  - npm install
  - brew update && brew install hugo

script:
  - rake

branches:
  only:
    - master

notifications:
  email: false

deploy:
  provider: pages
  skip_cleanup: true
  local_dir: public
  github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard
  on:
    branch: master
  repo: takuti/takuti.github.io
  target_branch: master
  fqdn: takuti.me

Once you have set your $GITHUB_TOKEN to environment variables in travis-ci.org, CI on source repository automatically generates your site and pushes it to GitHub Pages repository; now what we have to do is:

  1. Write an article under takuti.me/_content directory
  2. Commit & push takuti.me/* to repository (source), except for public/

Neat, huh?

In case that you are using custome domain on GitHub Pages like me, setting fqdn: as fqdn: takuti.me enables Travis CI to automatically create the CNAME file under xxx.github.io repository.

Next

Unfortunately, the CI-based deployment still has problems.

First, Deployment Bot removes all of your commit logs in xxx.github.io repository; it forcibly pushes to the repository:

travis-deploy-bot

In addition, since installation such as npm install and brew install is necessaly for every time CI is launched, deployment usually takes more than 5 minutes.

In fact, these are minor problems from a practical point of view, but I personally believe that deploying static site can be more efficient and technologically stimulating by different approach e.g., using Docker containers. So, I continuouslly try to update how to organize takuti.me.

  Support

  Gift a cup of coffee

  Categories

Engineering

  See also

August 31, 2019
Hello Netrify for Hosting a Static Site
April 30, 2017
Moving to GitHub Pages
October 19, 2015
Migrate to Hugo from Jekyll: Another Solution for the MathJax+Markdown Issue

  More

Last updated: April 12, 2020

  Author: Takuya Kitazawa

I am a product builder, mentor, and advocate for sustainable technology development with a decade of experience in AI/ML products, data systems, and digital transformation. Based in Canada and originally from Japan, I have lived and worked globally, including part-time residence in Malawi, Africa. Visit my portfolio to learn more about my work, or reach out to me at [email protected].

  Now

  Disclaimer

  • Opinions are my own and do not represent the views of organizations I am/was belonging to.
  • I use Grammarly and LanguageTool for correcting grammatical errors, but I do not rely on any other generative AI tools to create my blog content.
  • I am doing my best to ensure the accuracy and fair use of the information. However, there might be some errors, outdated information, or biased subjective statements due to the nature of a personal website. Visitors understand the limitations and rely on any information at their own risk.
  • If there are any issues with the content, please contact me so I can take the necessary action.