221 lines
13 KiB
HTML
Executable File
221 lines
13 KiB
HTML
Executable File
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>CruiseControl.NET : Modification Writer Task</title>
|
|
<link rel="stylesheet" href="styles/site.css" type="text/css" />
|
|
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
</head>
|
|
|
|
<body>
|
|
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
|
|
<tr>
|
|
<td valign="top" class="pagebody">
|
|
<div class="pageheader">
|
|
<span class="pagetitle">
|
|
CruiseControl.NET : Modification Writer Task
|
|
</span>
|
|
</div>
|
|
<div class="pagesubheading">
|
|
This page last changed on Mar 14, 2009 by <font color="#0050B2">dcameron</font>.
|
|
</div>
|
|
|
|
<p>This task writes the detected modifications for the current integration to a file as XML. This enables the modifications to be used by external programs, such as within a NAnt build script.</p>
|
|
|
|
<h4><a name="ModificationWriterTask-Minimalconfigurationexample%3A"></a>Minimal configuration example:</h4>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><modificationWriter /></span></pre>
|
|
</div></div>
|
|
|
|
<h4><a name="ModificationWriterTask-Fullconfigurationexample%3A"></a>Full configuration example:</h4>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><modificationWriter></span>
|
|
<span class="code-tag"><filename></span>mods.xml<span class="code-tag"></filename></span>
|
|
<span class="code-tag"><path></span><span class="code-tag"></path></span>
|
|
<span class="code-tag"><appendTimeStamp></span>False<span class="code-tag"></appendTimeStamp></span>
|
|
<span class="code-tag"></modificationWriter></span></pre>
|
|
</div></div>
|
|
|
|
<h4><a name="ModificationWriterTask-ConfigurationElements%3A"></a>Configuration Elements:</h4>
|
|
|
|
<table class='confluenceTable'><tbody>
|
|
<tr>
|
|
<th class='confluenceTh'> Node </th>
|
|
<th class='confluenceTh'> Description </th>
|
|
<th class='confluenceTh'> Type </th>
|
|
<th class='confluenceTh'> Required </th>
|
|
<th class='confluenceTh'> Default </th>
|
|
</tr>
|
|
<tr>
|
|
<td class='confluenceTd'> filename </td>
|
|
<td class='confluenceTd'> The filename for the file containing the modifications. </td>
|
|
<td class='confluenceTd'> string </td>
|
|
<td class='confluenceTd'> false </td>
|
|
<td class='confluenceTd'> modifications.xml </td>
|
|
</tr>
|
|
<tr>
|
|
<td class='confluenceTd'> path </td>
|
|
<td class='confluenceTd'> The directory to write the xml file to. </td>
|
|
<td class='confluenceTd'> string </td>
|
|
<td class='confluenceTd'> false </td>
|
|
<td class='confluenceTd'> the artifact directory </td>
|
|
</tr>
|
|
<tr>
|
|
<td class='confluenceTd'> appendTimeStamp </td>
|
|
<td class='confluenceTd'> Appends the integration start time to the filename, just before the extention. <br clear="all" />
|
|
Making it possible to create a modification file per integration, without overwriting existing ones. <br clear="all" />
|
|
Intended to be used with the <a href="Modification Reader Task.html" title="Modification Reader Task">ModificationReaderTask</a><br clear="all" /> </td>
|
|
<td class='confluenceTd'> bool <br clear="all" /> </td>
|
|
<td class='confluenceTd'> false <br clear="all" /> </td>
|
|
<td class='confluenceTd'> false <br clear="all" /> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class='confluenceTd'> description </td>
|
|
<td class='confluenceTd'> If filled in, this will be shown in the buildstage as the process name <br clear="all" /> </td>
|
|
<td class='confluenceTd'> string <br clear="all" /> </td>
|
|
<td class='confluenceTd'> false <br clear="all" /> </td>
|
|
<td class='confluenceTd'> n/a </td>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
<h4><a name="ModificationWriterTask-Outputformat"></a>Output format</h4>
|
|
|
|
<p>The modifications are written as follows:</p>
|
|
|
|
<h5><a name="ModificationWriterTask-XMLheader."></a>XML header.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"utf-8"</span>?></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Startofthegroupofmodifications%28evenifjustone%29."></a>Start of the group of modifications (even if just one).</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><ArrayOfModification <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="code-keyword">xmlns:xsd</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema"</span>></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Startofonemodification."></a>Start of one modification.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><Modification></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Thechangenumber."></a>The change number.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><ChangeNumber></span>... value .../ChangeNumber></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Thecomment."></a>The comment.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><Comment></span>... value ...<span class="code-tag"></Comment></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Theuser%27semailaddress."></a>The user's email address.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><EmailAddress></span>... value ...<span class="code-tag"></EmailAddress></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Theaffectedfilename."></a>The affected file name.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><FileName></span>... value ...<span class="code-tag"></FileName></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Theaffectfile%27sfoldername."></a>The affect file's folder name.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><FolderName></span>... value ...<span class="code-tag"></FolderName></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Thechangetimestamp%2CinyyyymmddThh%3Amm%3Ass.nnnnhhmmformat"></a>The change timestamp, in yyyy-mm-ddThh:mm:ss.nnnn-hhmm format</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><ModifiedTime></span>... value ...<span class="code-tag"></ModifiedTime></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Theoperationtype."></a>The operation type.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><Type></span>... value ...<span class="code-tag"></Type></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Theusername."></a>The user name.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><UserName></span>... value ...<span class="code-tag"></UserName></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-TherelatedURL."></a>The related URL.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><Url></span>... value ...<span class="code-tag"></Url></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Thefileversion."></a>The file version.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><Version></span>... value ...<span class="code-tag"></Version></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Endofmodification."></a>End of modification.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"></Modification></span></pre>
|
|
</div></div>
|
|
|
|
<h5><a name="ModificationWriterTask-Endofthegroupofmodifications."></a>End of the group of modifications.</h5>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"></ArrayOfModification></span></pre>
|
|
</div></div>
|
|
|
|
<h4><a name="ModificationWriterTask-Sampleoutput"></a>Sample output</h4>
|
|
|
|
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
|
|
<pre class="code-xml"><span class="code-tag"><?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"utf-8"</span>?></span>
|
|
<span class="code-tag"><ArrayOfModification <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="code-keyword">xmlns:xsd</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema"</span>></span>
|
|
<span class="code-tag"><Modification></span>
|
|
<span class="code-tag"><ChangeNumber></span>12245<span class="code-tag"></ChangeNumber></span>
|
|
<span class="code-tag"><Comment></span>New Project for testing stuff<span class="code-tag"></Comment></span>
|
|
<span class="code-tag"><EmailAddress></span>JUser@Example.Com<span class="code-tag"></EmailAddress></span>
|
|
<span class="code-tag"><FileName></span>AssemblyInfo.cs<span class="code-tag"></FileName></span>
|
|
<span class="code-tag"><FolderName></span>Dev\Server\Interface\Properties\<span class="code-tag"></FolderName></span>
|
|
<span class="code-tag"><ModifiedTime></span>2006-11-22T11:11:00-0500<span class="code-tag"></ModifiedTime></span>
|
|
<span class="code-tag"><Type></span>add<span class="code-tag"></Type></span>
|
|
<span class="code-tag"><UserName></span>joe_user<span class="code-tag"></UserName></span>
|
|
<span class="code-tag"><Url></span>http://www.example.com/index.html<span class="code-tag"></Url></span>
|
|
<span class="code-tag"><Version></span>5<span class="code-tag"></Version></span>
|
|
<span class="code-tag"></Modification></span>
|
|
<span class="code-tag"><Modification></span>
|
|
<span class="code-tag"><ChangeNumber></span>12244<span class="code-tag"></ChangeNumber></span>
|
|
<span class="code-tag"><Comment></span>New Project for accessing web services<span class="code-tag"></Comment></span>
|
|
<span class="code-tag"><EmailAddress></span>SSpade@Example.Com<span class="code-tag"></EmailAddress></span>
|
|
<span class="code-tag"><FileName></span>Interface<span class="code-tag"></FileName></span>
|
|
<span class="code-tag"><FolderName></span>Dev\Server\<span class="code-tag"></FolderName></span>
|
|
<span class="code-tag"><ModifiedTime></span>2006-11-22T11:10:44-0500<span class="code-tag"></ModifiedTime></span>
|
|
<span class="code-tag"><Type></span>add<span class="code-tag"></Type></span>
|
|
<span class="code-tag"><UserName></span>sam_spade<span class="code-tag"></UserName></span>
|
|
<span class="code-tag"><Url></span>http://www.example.com/index.html<span class="code-tag"></Url></span>
|
|
<span class="code-tag"><Version></span>4<span class="code-tag"></Version></span>
|
|
<span class="code-tag"></Modification></span>
|
|
<span class="code-tag"></ArrayOfModification></span></pre>
|
|
</div></div>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr>
|
|
<td height="12" background="http://confluence.public.thoughtworks.org//images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><font color="grey">Document generated by Confluence on Mar 14, 2009 02:55</font></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html> |