Setting up Travis, Jekyll and GitHub pages
Update, November 2017
I don't use this setup anymore, it might be outdated, proceed with caution.
As I already mentioned, GitHub pages do not work with the Jekyll plugins. It is a security measure. So I researched it a bit, and colleague of mine proposed a simple solution - Travis CI.
There is a great repo with instructions how to set everything up - jekyll-travis. But few steps are kinda confusing, and it took me 10 failed builds to make it work. So I'll try to help you with those.
I copied the steps from the original repo and updated steps where I got stuck. Be sure to check the original readme as well.
- When you push to your GitHub repo, it triggers Travis
- Travis starts up a virtual machine and installs all required software (mostly Ruby gems). We use a custom rake task to tell Travis how to build our Jekyll site and push the updated content back to Github
- Travis clones a source branch (usually
source, in my case
- Travis runs
jekyll buildon the source branch
- Travis does a
git pushto the branch holding static site files (usually
master, in my case
- Github Pages starts serving the updated site
Steps to make it work
Move your Jekyll source files to the
sourcebranch (name it as you like). We'll use
gh-pagesbranch to host generated HTML website.
Make sure you have enabled your source repo in the Travis CI admin dashboard so that the webhook is triggered
Create a GitHub Personal Access Token from you profile page.
If you haven't already, create a
Gemfile, and add
rakegem to it.
We have seen intermittent timeouts fetching gems from Rubygems.org.
install: bundle installlets Travis CI automatically retry, and we are using
source "http://production.cf.rubygems.org/"in Gemfile to point to a different repository.
Install the travis gem (
gem install travis) and create
.travis.yml. It will tell Travis what to install and how build our Jekyll site. Add following data to it.
language: ruby rvm: - 2.3.1 install: - bundle install script: bundle exec rake site:deploy --quiet env: global: secure: YOUR_ENCRYPTED_INFO
YOUR_ENCRYPTED_INFOwith the output of the following command:
Make sure you add
vendorto your .gitignore as Travis CI is vendoring the Ruby gems there. The
vendorfolder should also be excluded in the Jekyll
Add the following to your Jekyll
# GitHub username: Stanko repo: Stanko.github.io branch: source # Jekyll source / destination source: . destination: _site
Add the contents of
Rakefileto your Jekyll Rakefile (or replace it). The provided Rakefile has some additional commands, but the important one here is
And you are done! That should be it, of course you need to create a Travis CI account. Travis is free for the open source projects. If you are using it for the commercial stuff, play fair and check their payed tiers.
Build for my blog takes about a minute. It depends of the software Travis installs on every build.
Now you can use custom plugins and asset pipeline with Jekyll. Cheers!