Continuous Integration and Deployment with Middleman, Codeship, and GitHub Pages Dec 19, 2013
I like to run continuous integration for my projects whenever possible, and this goes for static site repositories as much as regular code repositories.
Recently, I started playing with Codeship. It’s a well-priced continuous integration and deployment service, and I wanted to be able to automatically deploy my middleman site upon successful builds to the master branch. It took a bit of trial and error, but I finally got something that works well.
After initializing a new GitHub repository in Codeship, you’ll need to define how tests are run. Under the Test project settings in Codeship, select Ruby as the language and define your Setup Commands and Test Commands.
bundle exec middleman build
Perfect. Now your site will run a test build upon every code push.
This is where I had some trouble, but I finally found a set of commands that
correctly deloyed to our
gh-pages branch in the repository. First, it’s
worth mentioning that I use the
middleman-gh-pages gem for
deploying to the
gh-pages branch. This gem gives you a
rake publish task
that handles most of the dirty work.
Under the Deployment project settings in Codeship, configure a deployment from the master branch using a Custom Script.
git config --global user.email "firstname.lastname@example.org" git config --global user.name "Codeship Robot" rm -rf build git remote set-branches --add origin gh-pages git fetch bundle exec rake publish sleep 30 wget --retry-connrefused --no-check-certificate -T 60 http://yoursite.com/
This configures a git user, removes the
build directory that was left there
from the test steps, adds a
gh-pages remote branch (because Codeship only
clones the relevant branch during setup), and runs the
rake publish task to
deploy the site to the
If all went well, your site will automatically deploy to GitHub Pages upon a push and successful build in the master branch.
GitHub Publishing Caveat
Make sure the email address that you use for this git user is a verified email address in your GitHub account. Otherwise, GitHub will accept the commit, but it will not publish the changes to your site. To fully make everything work, you will need to do one of two things: 1) Move the Codeship deploy key to an SSH key in your own GitHub account OR 2) Create a new machine user on GitHub and move the Codeship deploy key to an SSH key on that user account, give that machine user push/pull access to the repository, and make sure that machine user’s email address is fully verified by GitHub. I highly recommend going with option #2.
Extra Credit: Force Codeship to skip builds on the gh-pages branch.
Unfortunately, Codeship currently tries to run builds on all branches,
gh-pages branch. This is undesirable for this setup, so to
avoid this, we also need to add “–skip-ci” or “[skip ci]” to the commit
message that is pushed to the gh-pages branch.
Fortunately, after this pull-request by yours truly, middleman-gh-pages can support that.
If using version >= 0.0.3 (or the master branch), you can add this to the bottom of your project’s Rakefile:
# Ensure builds are skipped when pushing to the gh-pages branch ENV["COMMIT_MESSAGE_SUFFIX"] = "[skip ci]"
Tweet Follow @rmm5t