Skip to end of metadata
Go to start of metadata

FishEye has a "watch" notification system that sends email notifications to users when commits are detected. Users can opt in for these notifications by "watching" a particular repository/activity stream.

Email notifications in FishEye can be customised to change their formatting, by editing template files. This page contains instructions for this process.

Editing FishEye email templates

Template files for FishEye are stored in the <FishEye home directory>/template/fisheye and <FishEye home directory>/template/shared folders.

There are sets of templates for both HTML and plain-text emails, as listed in the table below. Note that these templates do not support embedding full diffs into notifications. They are only for changing the appearance and order of certain content inside the messages.

You can edit templates in any text editor.

After an edit, the change to the email template will take place immediately. No restart is required.

Icon

If you edit the templates of an operational FishEye instance, you may disrupt notifications that are being sent at that time. To avoid this, shut FishEye down during template editing.

Try and avoid editing the live template file, as FishEye may try to use it while you are editing. This could have unpredictable results. Instead, back up the template file (it's wise to keep original versions of all these files), edit a copy you have made, then overwrite the 'live' template once you have finished.

Advanced editing of FishEye email templates

The email notification templates use the Freemarker format. Freemarker is a general templating engine enabling automated content.

If you are familiar with Freemarker, more advanced customisations can be made to the email notification templates. However, you make such adjustments at your own risk.

FishEye email template file list

The following template files for FishEye notifications are stored in the FISHEYE_HOME/template/fisheye/ folder, or its subfolders.
 

Template filenameHTMLPlain-text
changeset-mail-subject.ftlBoth
changeset-header.ftlShared

util.ftlShared

changeset-mail.ftl(tick)(tick)
fisheye-layout.ftl(tick)(tick)
fisheye-support-request.ftl(error)(tick)
password-reset.ftl(tick)(tick)
plugin-notification.ftl(tick)(tick)
verify-password-reset.ftl(tick)(tick)

See also Customising Crucible Email Notifications.

  • No labels