SvnPlugin

Overview

The SVN plugin intends to improve traceability of coding activities and integration with tools for web-browsing code repositories. It map s tickets with tasks, bugs, enhancements to commit messages and revisions in a subversion repository.

Syntax Rules

%SVNTIMELINE{  parameters here }%

%SVNTIMELINE{  parameters here }%

%SVNTICKETREF{  parameters here }% 

Parameters

Examples

SVNTIMELINE example

%SVNTIMELINE{ 
  ticketprefix="MyProject"  
  svnpath= "svn://projectserver/svn/MyProject/trunk/" 
  format="|[[http://projectserver/websvn/listing.php?repname=svn&path=MyProject&rev=$rev][rev.$rev]] |$author |$msg  |" 
}%

rev.123	vaclav	fix of #3 bug
rev.122	vaclav	implementation of GUI feature, ticket #2
rev.121	vaclav	some other commit which does not reference any ticket
rev.120	vaclav	parser enhancement, ticket #1

SVNTICKETREF example

%SVNTICKETREF{
  ticketprefix="MyProjectTicket"
  ticketnum="%CALC{$EVAL(%TOPIC%)}%"  
  svnpath= "svn://projectserver/svn/MyProject/"
  format="|[[http://projectserver/websvn/listing.php?repname=svn&path=MyProject&rev=$rev][rev.$rev]] |$author |$msg  |" 
}%

SVNTICKETREF searches through the message logs of the repository and shows the ones referencing "ticketnum" number in a same table as above example.
SVNTICKETREF is intended to be in every MyProjectTicket. (The ticket is created via some ticket template)

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %SVNPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Improves traceability of task and commits with subversion repository

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the adminis trator who installs the plugin on the TWiki server.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below)
  • Unzip SvnPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/SvnPlugin.txt	Plugin topic
    lib/TWiki/Plugins/SvnPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration:
  • Run the configure script and enable the plugin in the Plugins section.

• The plugin expects that the subversion client is available on the server where TWiki is installed.

Plugin Info

Plugin Author:	TWiki:Main.VasekOpekar
Copyright:	© 2006, TWiki:Main.VasekOpekar © 2008-2011 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-03-03
Change History:
2011-03-03:	TWikibug:Item6638: Doc fixes, changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
10 Nov 2006:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	Subversion client must be installed on the TWiki server
Perl Version:	5.005
Benchmarks:	GoodStyle nn%, FormattedSearch nn%, SvnPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SvnPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SvnPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/SvnPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences