Customizing Commit Messages

[rmm5t]

I've been experimenting with different continuous integration/deployment services lately. Not all are smart enough to skip builds on the gh-pages branch (specifically, I'm talking about Codeship), but one way around this is to add a message like "--skip-ci" or "[skip ci]" to the commit message to avoid the build.

So, what I'd like to suggest is an ability to customize the commit message that gets pushed to the gh-pages branch. I'm happy to code this up, but I wanted to get some buy-in for this feature first. I'm also looking for some guidance of how you'd like this implemented, because there are several ways to potentially handle this.

1. Allow a message argument to add a suffix to the publish task's commit message (meh)
2. Allow for an env variable to specify a suffix for the commit message (easy)
3. Build in some form of configurable commit message template (probably unnecessarily complex)
4. Always add "[skip ci]" to commit messages (easy, but not exactly ideal and limiting)

Thoughts?

[rmm5t]

I actually needed some sort of behavior sooner than later, so i started experimenting with a couple branches. I decided to go with a custom env var to manage a commit message suffix. For example, here's how I'm deploying so that Codeship doesn't pick up and build the gh-pages branch upon publishing a new version of a site:

bundle exec rake publish COMMIT_MESSAGE_SUFFIX="--skip-ci"

[rmm5t]

For any future onlookers, I also just published a blog post about this topic and my underlying process of getting continuous deployment to work with middleman, middleman-gh-pages, and Codeship:

http://ryan.mcgeary.org/2013/12/19/continuous-integration-deployment-middleman-codeship-github-pages/

[rmm5t]

@adamlogic What do you think of this pull-request? Any chance of getting it pulled in, and getting a version bump?

[adamlogic]

@rmm5t Sorry I've been slacking on these PRs. I'm no longer actively maintaining any Middleman sites, so before I bump the version, can you make sure the master branch is working for you?

[rmm5t]

@adamlogic Just tested. Master branch works great. Thanks! A version bump would be awesome.

[rmm5t]

@adamlogic Also, if you're looking for help maintaining this gem, I'd be glad to help. I help out with several different projects when I can. If you want to add me to this repository and give me gem push rights, I'd be glad to help out. Not that I think this gem needs much change, but I use this gem on several projects and have a vested interest.

Either way. Just throwing that out there.

[adamlogic]

@rmm5t Offer accepted! You should have commit access now. Thanks so much for helping out!