Name
SVN::Notify::HTML - Subversion activity HTML notification
Synopsis
Use svnnotify in post-commit:
svnnotify --repos-path "$1" --revision "$2" \
--to developers@example.com --handler HTML [options]
Use the class in a custom script:
use SVN::Notify::HTML;
my $notifier = SVN::Notify::HTML->new(%params);
$notifier->prepare;
$notifier->execute;
Description
This subclass of SVN::Notify sends HTML formatted email messages for Subversion activity, rather than the default plain text.
Prerequisites
In addition to the modules required by SVN::Notify, this class requires:
Usage
To use SVN::Notify::HTML, simply follow the instructions in SVN::Notify, but when using svnnotify, specify --handler HTML
.
Class Interface
Constructor
new
new
my $notifier = SVN::Notify->new(%params);
Constructs and returns a new SVN::Notify object. All parameters supported by SVN::Notity are supported here, but SVN::Notify::HTML supports a few additional parameters:
- linkize
-
svnnotify --linkize
A boolean attribute to specify whether or not to "linkize" the SVN log message--that is, to turn any URLs or email addresses in the log message into links.
- rt_url
-
svnnotify --rt-url 'http://rt.cpan.org/NoAuth/Bugs.html?id=%s'
The URL of a Request Tracker (RT) server. If passed in, any strings in the log message of the form "Ticket # 12" or "ticket 6" or even "Ticket#1066" will be turned into links to the RT server. The URL must have the "%s" format where the RT ticket ID should be put into the URL.
- bugzilla_url
-
svnnotify --bugzilla-url 'http://bugzilla.mozilla.org/show_bug.cgi?id=%s'
The URL of a Bugzilla server. If passed in, any strings in the log message of the form "Bug # 12" or "bug 6" or even "Bug#1066" will be turned into links to the Bugzilla server. The URL must have the "%s" format where the Bugzilla Bug ID should be put into the URL.
- jira_url
-
svnnotify --jira-url 'http://jira.atlassian.com/secure/ViewIssue.jspa?key=%s'
The URL of a Jira server. If passed in, any strings in the log message that appear to be Jira keys (such as "JIRA-1234") will be turned into links to the Jira server. The URL must have the "%s" format where the Jira key should be put into the URL.
Class Methods
content_type
Returns the content type of the notification message, "text/html". Used to set the Content-Type header for the message.
Instance Interface
Instance Methods
start_body
$notifier->start_body($file_handle);
This method starts the body of the notification message. It outputs the opening <html>
, <head>
, <style>
, and <body>
tags. Note that if the language
attribute is set to a value, it will be specified in the <html>
tag.
output_css
$notifier->output_css($file_handle);
This method starts outputs the CSS for the HTML message. It is called by start_body()
, and which wraps the output of output_css()
in the appropriate <style>
tags.
output_metadata
$notifier->output_metadata($file_handle);
This method outputs a definition list containting the metadata of the commit, including the revision number, author (user), and date of the revision. If the viewcvs_url
attribute has been set, then the appropriate URL for the revision will be used to turn the revision number into a link.
output_log_message
$notifier->output_log_message($file_handle);
Outputs the commit log message in <pre>
tags, and the label "Log Message" in <h3>
tags. If the bugzilla_url
attribute is set, then any strings like "Bug 2" or "bug # 567" will be turned into links.
output_file_lists
$notifier->output_log_message($file_handle);
Outputs the lists of modified, added, deleted, files, as well as the list of files for which properties were changed as unordered lists. The labels used for each group are pulled in from the file_label_map()
class method and output in <h3>
tags.
end_body
$notifier->end_body($file_handle);
Closes out the body of the email by outputting the closing </body>
and </html>
tags. Designed to be called when the body of the message is complete, and before any call to output_attached_diff()
.
output_diff
$notifier->output_diff($out_file_handle, $diff_file_handle);
Sends the output of svnlook diff
to the specified file handle for inclusion in the notification message. The diff is output between <pre>
tags, and Each line of the diff file is escaped by HTML::Entities::encode_entities()
. The diff data will be read from $diff_file_handle
and printed to $out_file_handle
.
See Also
Author
David Wheeler <david@kineticode.com>
Copyright and License
Copyright (c) 2004 Kineticode, Inc. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.