Skip to content

indirect/git-commit-notifier

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Git Commit Notifier

Sends email commit messages splitting commits that were pushed in one
step. Email is delivered as text or HTML with changes refined per
word. Emails have a scanable subject containing the first sentence of
the commit as well as the author, project and branch name.

A reply-to header is added containing the author of the commit. This makes follow up really simple.

For example:

[rails][master] Fix Brasilia timezone. [#1180 state:resolved] 

If multiple commits are pushed at once, emails are numbered in chronological order:


[rails][master]000 Added deprecated warning messages to Float#months and Float#years deprications.
[rails][master]001 Enhance testing for fractional days and weeks. Update changelog.

Example email:

Requirements

  • Ruby and RubyGems
  • SMTP server or sendmail compatible mailer

Installing and Configuring

Install the gem:

gem install git-commit-notifier

Link the script in as your post-receive hook:

cd /path/to/your/repo.git/hooks
ln -s `which git-commit-notifier` post-receive

Edit the configuration to suit you:

  • git config hooks.mailinglist (email address of the recipient, probably your mailing list address)
  • git config hooks.emailprefix (application name for subject line, defaults to repo name)
  • git config hooks.smtpserver (optional hostname:port of your smtp server, default is localhost)
  • git config hooks.smtpuser (username for external smtp)
  • git config hooks.smtppassword (password for external smtp)

Contributions

Original by Csoma Zoltan (Primalgrasp), with a pretty thorough makeover by Andre Arko (indirect).

License

MIT License, see the file LICENSE.

About

Sends HTML email commit messages splitting commits that were pushed in one step. Changes are highlighted per word.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Ruby 100.0%