Date Parameter¶
This will prompt the user to enter a date value when a force build is requested.
This parameter can then be used by a dynamic value in a task.
Version¶
Available from version 1.5
Examples¶
Minimalist example
1<dateParameter>
2 <name>CutOffDate</name>
3</dateParameter>
Full example
1<dateParameter>
2 <name>CutOffDate</name>
3 <display>Cut Off Date</display>
4 <description>What is the cut-off date for changes?</description>
5 <default>today</default>
6 <minimum>1-Jan-2000</minimum>
7 <maximum>31-Dec-2100</maximum>
8 <required>false</required>
9</dateParameter>
Example in Context
1<project name="Test Project">
2 <sourcecontrol type="svn">
3 <!-- Omitted for brevity -->
4 </sourcecontrol>
5 <triggers>
6 <intervalTrigger />
7 </triggers>
8 <tasks>
9 <!-- Omitted for brevity -->
10 </tasks>
11 <publishers>
12 <!-- Omitted for brevity -->
13 </publishers>
14 <parameters>
15 <dateParameter>
16 <name>CutOffDate</name>
17 <display>Cut Off Date</display>
18 <description>What is the cut-off date for changes?</description>
19 <default>today</default>
20 <minimum>1-Jan-2000</minimum>
21 <maximum>31-Dec-2100</maximum>
22 <required>false</required>
23 </dateParameter>
24 </parameters>
25</project>
Configuration Elements¶
Element | Description | Type | Required | Default | Version |
default | The default value to use. | String | No | None | 1.5 |
description | The description of the parameter. | String | No | None | 1.5 |
display | The display name of the parameter. | String | No | None | 1.5 |
required | Is the parameter required? | Boolean | No | false | 1.5 |
maximum | The maximum allowed value of the parameter. | DateTime | No | 31-Dev-9999 | 1.5 |
minimum | The mimimum allowed value of the parameter. | DateTime | No | 1-Jan-0000 | 1.5 |
name | The name of the parameter. | String | Yes | n/a | 1.5 |
Automatically Generated¶
Documentation generated on Monday, 26 May 2014 at 7:17:59 AM