The Blog that Noone Reads

A domain specific language for implementing svn repository hooks in ruby.

The goal of this project is to allow developers or sysadmins an easier method for responding to svn hook events. The default behavior of subversion is to call an executable script based on the type of event that’s occurred. For places where multiple projects may exist under a single repository, this becomes a bit complicated since it’s probably desirable to respond differently depending on what project has been modified by a commit.

Important: This package is still in early stages of development. Everything you read here is subject to change until version 1.0.0.

Installation:

You can download the gem from RubyForge or just install using the ruby gems command line:

sudo gem install svn_hooks

Once installed, you’ll need to run the setup script on your svn repository (on the server side):

svn_rubyhooks /path/to/my/repository

This will do a couple things. First, it will create all of the callback files that are expected by svn in the hooks directory. If there are existing scripts, they will be moved out of the way by appending their filenames with .old. Next, it will create a scripts directory within the hooks directory.

Usage:

When any event happens to the repository that will trigger one of the event scripts, every script in the hooks/scripts directory with a .rb extension will be executed. Within these scripts, you can use the following filters for deciding how and when your code is executed.

Path Based Filtering

Code within this block will only be executed if files within the specified path or paths have been modified.

for_path 'repo/projects/my_project/trunk/*' do
  #... event handler here
end

Event Based Filtering

Code within this block will only be executed in response to a specific svn event.

for_event 'post-commit' do
  #... event handler here
end

Nested Filters

The preferred method is to filter on both event and path

for_event 'post-commit' do
  for_path 'repo/projects/my_project/trunk/*' do
    #... event handler here
  end
end

Event Details

All filter blocks can optionally receive as SVN::Stat object, which can provide many details about the event.

for_event 'post-commit' do |details|
  puts details.revision
  puts details.event
  puts details.author
  puts details.date
  puts details.files
end

This entry was posted on Sunday, November 25th, 2007 at 1:54 am and is filed under Uncategorized. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.