Modification Writer Task¶
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.
Version¶
Available from version 1.0
Examples¶
Minimalist example
1<modificationWriter />Full example
1<modificationWriter>
2 <filename>mods.xml</filename>
3 <path></path>
4 <appendTimeStamp>False</appendTimeStamp>
5</modificationWriter>Configuration Elements¶
| Element | Description | Type | Required | Default | Version |
| appendTimeStamp | Appends the integration start time to the filename, just before the extention. Making it possible to create a modification file per integration, without overwriting existing ones. Intended to be used with the Modification Reader Task. | Boolean | No | false | 1.0 |
| description | Description used for the visualisation of the buildstage, if left empty the process name will be shown. | String | No | The task/publisher name. | 1.5 |
| dynamicValues | The dynamic values to use for the task. | Dynamic Values array | No | None | 1.5 |
| environment | A set of environment variables set for commands that are executed. Each variable should be specified as . |
Environment Variable array | No | ||
| filename | The filename for the file containing the modifications. | String | No | modifications.xml | 1.0 |
| path | The directory to write the xml file to. | String | No | Project Artefact Directory | 1.0 |
Notes¶
Output format¶
The modifications are written as follows:
1<!-- Start of the group of modifications (even if just one). -->
2<ArrayOfModification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
3 <!-- Start of one modification. -->
4 <Modification>
5 <!-- The change number. -->
6 <ChangeNumber>... value ...</ChangeNumber>
7 <!-- The comment. -->
8 <Comment>... value ...</Comment>
9 <!-- The user's email address. -->
10 <EmailAddress>... value ...</EmailAddress>
11 <!-- The affected file name. -->
12 <FileName>... value ...</FileName>
13 <!-- The affect file's folder name. -->
14 <FolderName>... value ...</FolderName>
15 <!-- The change timestamp, in yyyy-mm-ddThh:mm:ss.nnnn-hhmm format -->
16 <ModifiedTime>... value ...</ModifiedTime>
17 <!-- The operation type. -->
18 <Type>... value ...</Type>
19 <!-- The user name. -->
20 <UserName>... value ...</UserName>
21 <!-- The related URL. -->
22 <Url>... value ...</Url>
23 <!-- The file version. -->
24 <Version>... value ...</Version>
25 <!-- End of modification. -->
26 </Modification>
27 <!-- End of the group of modifications. -->
28</ArrayOfModification>Sample output¶
1<ArrayOfModification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
2 <Modification>
3 <ChangeNumber>12245</ChangeNumber>
4 <Comment>New Project for testing stuff</Comment>
5 <EmailAddress>JUser@Example.Com</EmailAddress>
6 <FileName>AssemblyInfo.cs</FileName>
7 <FolderName>Dev\Server\Interface\Properties\</FolderName>
8 <ModifiedTime>2006-11-22T11:11:00-0500</ModifiedTime>
9 <Type>add</Type>
10 <UserName>joe_user</UserName>
11 <Url>http://www.example.com/index.html</Url>
12 <Version>5</Version>
13 </Modification>
14 <Modification>
15 <ChangeNumber>12244</ChangeNumber>
16 <Comment>New Project for accessing web services</Comment>
17 <EmailAddress>SSpade@Example.Com</EmailAddress>
18 <FileName>Interface</FileName>
19 <FolderName>Dev\Server\</FolderName>
20 <ModifiedTime>2006-11-22T11:10:44-0500</ModifiedTime>
21 <Type>add</Type>
22 <UserName>sam_spade</UserName>
23 <Url>http://www.example.com/index.html</Url>
24 <Version>4</Version>
25 </Modification>
26</ArrayOfModification>Automatically Generated¶
Documentation generated on Monday, 26 May 2014 at 7:18:04 AM