Tags:
create new tag
, view all tags

SvnPlugin

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 }%
shows formated and referenced commit messages
%SVNTICKETREF{  parameters here }% 
shows the commit messages related to a specific ticket

Parameters

Name Description
ticketprefix Ticket name without a number, tipicaly there will be severl tickets startin from MyProjectTicket1 to MyProjectTicketXXXX in this cast the ticketprefix will be "MyProjectTicket"
svnpath Path to a subversion repository
ticketnum Specifies the number of a ticket we are searching for (used only in SVNTICKETREF)
format The usual parameter, $rev is replaced with a revision number
$author with an autor name, and $msg with commit log of a specific revision
limit Limit the search for n last revisions

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  |" 
}%
Produces a table (this is a fake!) with subversion logs hyperlinked to websvn repository viever to a specific revision and to a related ticket with described activity. Every "#number" pattern in commit log is replaced with a link to a ticket specified by ticketprefic parameter.
eg. #2 -> MyProjectTicket2

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. ( 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. %NEWPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Improves tracibility of task and comits with suversion 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 administrator who installs the plugin on the TWiki server.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip SvnPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/SvnPlugin.txt Plugin topic
    data/TWiki/SvnPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/SvnPlugin.pm Plugin Perl module
  • Configure the Plugin:
    • TWiki 4.0 and up: Run the configure script to enable the Plugin
    • Change the Plugin settings as needed
  • Plugins expects subversion client to be available on the server with TWiki instalation

Plugin Info

Plugin Author: TWiki:Main.VasekOpekar
Copyright: © 2006, TWiki:Main.VasekOpekar
License: GPL (GNU General Public License)
Plugin Version: 10 Nov 2006 (V1.000)
Change History:  
10 Nov 2006: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: Subversion client on the TWiki server must be installed
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

-- TWiki:Main.VasekOpekar - 10 Nov 2006

Topic revision: r4 - 2006-11-10 - VaclavOpekar
 
This site is powered by the TWiki collaboration platformCopyright & 1999-2021 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.SvnPlugin.