pf » Using Subversion Hooks to send out build emails

February 23, 2005

Using Subversion Hooks to send out build emails

The subversion version control system has a wonderfully handy feature called hooks. Hooks are essentially scripts that are triggered by a version control event (such as a commits, or revision property changes).

Subversion Hooks are located in your repository directory (so if you have multiple repositories you have to setup hooks for each one) in a directory called hooks, perhaps something like this: /home/svn/projectName/hooks. There are template files (.tmpl) in the directory for each event (these files are just examples). The events are:

start-commit - run before commit transaction begins, can be used to do special permission checking
pre-commit - run at the end of the transaction, but before commit. Often used to validate things such as a non zero length log message.
post-commit - runs after the transaction has been committed. Can be used for sending emails, or backing up repository.
pre-revprop-change - runs before a revision property change. Can be used to check permissions.
post-revprop-change - runs after a revision property change. Can be used to email or backup these changes.

In your hooks directory you will find a .tmpl file with each of the event names, if you want to enable one of the hooks, copy the template file (without the .tmpl extension) and make it executable.

Note: On windows you need to rename the .tmpl file with an extension that is executable by windows such as an exe or bat file.

If you want to send out a build email on post-commit copy the post-commit.tmpl file to post-commit and make it executable. Edit the file, and add your email addresses.

Subversion comes with a few other pre-built hook scripts, there is a hot-backup.py script that can be used to make hot backups of your repository after commits.

You can find more info about this in the Version control with Subversion book which can also be found here

Permalink | Add Comment |

add to del.icio.us | Tags: subversion, version control, hooks

Related Entries

Bug Report hooks for FindBugs and Subversion - May 9, 2005
Subversion commit message validator pre-commit hook - May 31, 2005
Top 10 Things I like about subversion - February 22, 2005
Subversion Better than CVS? - March 4, 2004

6 people found this page useful, what do you think?

Trackbacks

Trackback Address: 244/82BC5CEE3BECD175F9A68456DF2F9F1A

Comments

On 02/24/2005 at 1:58:17 AM MST Aslak Hellesoy wrote:

You are describing how to send out emails containing the results of a svn commit, not a *build* of the code in the repository.

But your blog title mentions "build emails". How can you use svn hooks to email results of a build?

Did I miss something?

On 02/24/2005 at 8:35:30 AM MST Pete Freitag wrote:

Hi Aslak,

We actually use subversion hooks to do just that, we send the results of the ant build script and also the svn commit. Basically what you need to do is write the results of your build to a file, and include the contents of the file in the email

On 02/24/2005 at 9:54:52 AM MST Aslak Hellesoy wrote:

Fred, thanks for your reply. Got it.

AFAIK, the various hook scripts execute in a synchronous fashion, keeping the svn client blocked until everything is complete.

In other words, I'm assuming your svn client is blocked until your build is complete (correct me if I'm wrong).

Since commit transactions now become potentially very long (a build of a project typically takes from 10 secs to 30 minutes) - how does this impact your work?

Does svn allow concurrent commits? (I.e. can Sue commit while Fred's commit is in process?) If concurrent commits are not possible, wouldn't your setup potentially cause developers to have to queue up in order to commit their changes?

On 02/24/2005 at 10:25:18 AM MST Pete Freitag wrote:

If you run with a post-commit hook, your svn client returns, and the build goes on in the background, and emails you when its done.

On 02/25/2005 at 1:01:34 PM MST Aslak Hellesoy wrote:

Are you saying that Subversion's post-commit hooks fork a new process? -Or do you fork a process yourself in the post-commit script?

What I mean is that unless there is a fork (done by svn or your hook script), I don't see how the client would *not* hang ?!

On 05/09/2005 at 12:19:16 PM MDT Pete Freitag wrote:

Aslak, The client does not hang, so subversion must fork a new process or thread to handle the post-commit operations.

On 10/25/2005 at 5:02:56 PM MDT Jennifer wrote:

I copied the post-commit template and chmod +x to make it an executable. I also added my email to the post-commit file. I've tried commiting a changed file in the svn repository, but I still don't receive an email about the change.

On 12/21/2005 at 4:30:11 PM MST Armando wrote:

By "edit the file", what the author means, I think, is "configure to your needs."

In my tmpl file, commit-email.pl was getting called, but it is not a program in my $PATH. As the post-commit.tmpl file said, checkout http://svn.collab.net/repos/svn/trunk/tools/hook-scripts/ to find a script, or look to see if commit-email.pl was include in /usr/share somewhere (as packaged by your distro). Then you can copy it somewhere, and call it explicitly.

On 02/23/2006 at 6:06:09 AM MST Mark Andrews wrote:

Hello, Can any one point me to what is needed to enable the revprop change hook when running the SVN server on Windows?

On 07/07/2006 at 3:48:24 PM MDT Joep wrote:

You can also use SVNRevMailer to send e-mail reports. This application does not use hooks, so it needs to be scheduled.

you can find it at: http://dev.nxt.myftp.org/projects/SVNRevMailer/

On 10/09/2006 at 2:49:33 PM MDT Laurens wrote:

SVNRevMailer is a nice tool. I use it a for while now, and the benefit of not being a hook is that you can let it send reports periodically (once a day, for example). So instead of an email per commit (which often means many emails) I receive a daily report containing all commits from the past day, for all repos I check out. This way I keep track of progress of all software I use.

On 10/19/2006 at 12:18:09 AM MDT xutm wrote:

i followed all the steps and the subversion did send a mail when i commit a change, but i found that the from segment of the mail had been changed to something else.How can i change it back to the original one?

On 08/15/2007 at 10:11:03 AM MDT Dave wrote:

Hello Dave,

How are you doing? I am doing just fine. It is a little hot here now, and I have to take a cool bath just to cool off.

Your mother said I would be glued to my computer, and people would come here and say where is Beth, and Martin would say who's Beth. Well she is right, cause I use this all of the time. I love computers. Well you know that.

Write to me any time you can, and I will write back to you.

love Beth

On 12/19/2007 at 8:25:15 PM MST mmckechney wrote:

For windows users, I've created an application that can handle pre-commit and post-commit Subversion hooks. The pre-commit hooks allow you to control what goes into your repository as well as validate commit messages. The post-commit sends out nicely formatted e-mails. This is a SourceForge.net project but is summarized on my site: http://mckechney.com/SubversionNotifyForWindows