SCM-Manager Plugins Part 2: Notify
The notify plugin provides the functionality of automatically generated notifications on commits to repositories. It requires at least the SCM-Manager version 1.15, other plugins are not required. At the moment the latest version is 1.2.
Installation and Configuration
The installation of this plugin is as simple as the installation of all other SCM-Manager plugins, just click the “Install”-button in the “Config → Repositories” screen and the latest version of the notify plugin will be installed.
After successful installation, the plugin can be easily configured at the “Config → General” screen, which consists of the fields: “Host“, “Port“, “Username“, “Password“, “From“, “Transport Strategy” and “Subject prefix“.
Enter the proper information of your email host and the email account from which the notification shall be sent. In the field “Transport Strategy” you can select the security level of the notification: plain means that the email password is sent without encryption. If you want to use an encryption protocol, select one of the other two options. SSL is the predecessor of TSL. Both are cryptographic protocols which use asymmetric cryptography for authentication. If you are using the notification in your intranet plain should be sufficient. The “Subject Prefix” can be used to, as its name says, add a prefix to each notification that will be sent. This feature will help you assigning filters in your inbox for SCM-Manager notifications more easy. If you want to test your configuration, you have to enter the email address of the recipient in the popup field.
Now you are already finished with the general configuration of the notify plugin. It´s time to declare who should be informed about changes of certain repositories.
In this tab you can enter email addresses of people that shall receive notifications about commits to the chosen repository by clicking “Add” and saving by clicking “OK“. The “Repository Contact” is set in the “Settings-tab“, he is the default contact of a repository. From now on, everybody in this list will receive a notification about commits/pushs to the repository. The notification email looks like this:
First you can see the subject, consisting of the “Subject Prefix” and the name of the repository, the date and the sender of the notification, which you have set in the configuration. Below that you have information about the changesets: a link to the repository in the SCM-Manager, the name of the person who made the change and the commit message. And that´s it!
Maybe you are now asking yourself “What´s it worth, why all that?”. Well, it reduces the administrative work. The flow of information is more automatized. You don´t have to care about passing on the information yourself. Everybody who is notified is informed about the stage of affairs, and you can concentrate on more important things like writing some code.
your SCM-Manager Support Team