Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
.gitignore
README.md
jekyll-commit-blog.gemspec

README.md

Jekyll Commit Blog

A command that will create a Jekyll markdown file based off a git commit message. The command can optionally be installed as a commit hook.

It looks for a commit message that ends with {BLOG} and generates a Jekyll post file for it in the current directory. You can optionally add front matter to your posts by specifying it in the blog tag like this {BLOG tags=[foo, bar]&layout=test}.

Installation

Install this command using rubygems.

$ gem install jekyll-commit-blog

Usage

You can run the command in the current directory for the latest commit like this

$ jekyll-post-commit

If you'd rather run the command in another project then you can specify the project directory using the -p option

$ jekyll-post-commit -p /path/to/project

You can specify a commit using the -c option. You can either use the full or partial commit hash or the HEAD offset.

$ jekyll-post-commit -c HEAD~
$ jekyll-post-commit -c 123abc

NOTE: If you specify a commit then a Jekyll file will be generated regardless of if a {BLOG} tag is at the end of the commit message.

If you want the command to generate the blog post some where other than the cwd, use the -o option

$ jekyll-post-commit -o /path/to/jekyll/_posts

Installation as a commit hook

You can install this command as a git post-commit hook (a hook that's run after a commit). Execute the command with the -p and -i options.

$ jekyll-post-commit -p /path/to/project -i

This will make sure that the necessary gems are installed and then prompts you for the location of the project you want to use the hook with. It then copies the hook to the <project>/.git/hooks directory.