Setting Up Git Commit Email Notifications
A method to send email notification to a list email addresses by the remote git server after every push from the client will be introduced.
After the client pushing to the git server, several actions are triggered. These actions are done by hooks. Hooks are scripts placed in the GITDIR/hooks directory. Here, GITDIR is the directory of the git repository on the git server. One of the trigger action is post-receive, so we can put a executable script with name post-receive under GIT_DIR/hooks. For every push by client, post-receive will be executed to send email notification.
A sample notification email after client pushing two commits is show in the figure. The subject contains a prefix, the repository name and the last commit message. The body of the email contains the commit log and summary of the changes.
Now lets go to the detail of configuring the mechanism.
Get the post-receive script
My script that sends email like the example described above can be downloaded from: git post-receive script.
Or view the source code: git post-receive script
This script use smtp server to send email. You need to change the smtp server address at the end of the script. Simply change smtp=”smtp://smtp.cse.ust.hk” to the smtp server you use. You can not use my smtp server which is only allowed to send email without authorization inside of CSD in HKUST. If you like to use Gmail’s smtp, please refer to Sending Email from mailx Command on Linux Using Gmail’s Smtp.
This script is changed from Andy Parkins’s one which is in git’s distribution. On fedora 12, the original script can be found under /usr/share/git-core/contrib/hooks.
Put post-receive into hooks directoryAfter getting the post-receive script, you need to copy it to GIT_DIR/hooks/ directory on the git server.
Please note that this script should be executable. You may need to add executable mod bits to post-receive by
chmod a+x hooks/post-receivewhen you are in GITDIR.
Change repository descriptionThe repository name in the email subject is the first line of $GITDIR/description. Change the first line of the description file to you project’s name.
Change configThe sender’s email address, the mail list and the subject prefix is defined in GIT_DIR/config file. I like to edit this config file by hand which is as easy as using git config command.
Add these line to the config file:
[hooks] mailinglist = "email@example.com firstname.lastname@example.org" senderemail = "email@example.com"The email addressed in mailing list is separated by space.
The default subject prefix is [GIT]. You can change it to any string you like by add hooks.emailprefix in config.
Now the email notification mechanism has been set up. You can change the script if more functions is needed.