-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathPowershell.xml
184 lines (182 loc) · 6.21 KB
/
Powershell.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?xml version="1.0" encoding="UTF-8"?>
<dsl-extension kind="buildStep" type="jetbrains_powershell" generateDslJar="true">
<class name="PowerShellStep">
<description>
A [build step](https://www.jetbrains.com/help/teamcity/?PowerShell) running PowerShell script
</description>
</class>
<function name="powerShell">
<description>
Adds a [build step](https://www.jetbrains.com/help/teamcity/?PowerShell) running PowerShell script
@see PowerShellStep
</description>
</function>
<params>
<param name="jetbrains_powershell_minVersion" dslName="minVersion" type="Version">
<deprecated>This property allows to specify a limited number of versions, please use minRequiredVersion instead.</deprecated>
</param>
<param name="jetbrains_powershell_minVersion" dslName="minRequiredVersion">
<description>
A minimum required PowerShell version installed on a build agent
</description>
</param>
<param name="jetbrains_powershell_bitness" dslName="platform" type="Platform">
<description>
A required platform bitness
@see Platform
</description>
</param>
<param name="jetbrains_powershell_edition" dslName="edition" type="Edition">
<description>
PowerShell edition to use
@see Edition
</description>
</param>
<param name="jetbrains_powershell_errorToError" dslName="formatStderrAsError" type="boolean" trueValue="true" falseValue="">
<description>
Specifies how the error output is handled. If set to true any output to stderr is handled as an error.
By default any output to stderr is handled as a warning.
</description>
</param>
<param name="teamcity.build.workingDir" dslName="workingDir">
<description>
[Build working directory](https://www.jetbrains.com/help/teamcity/?Build+Working+Directory) for ant script,
specify it if it is different from the [checkout directory](https://www.jetbrains.com/help/teamcity/?Build+Checkout+Directory).
</description>
</param>
<param name="jetbrains_powershell_script_mode" dslName="scriptMode" type="compound" mandatory="true">
<description>
PowerShell script execution mode
</description>
<option name="file" value="FILE">
<description>
Run a PowerShell script at the given path
</description>
<param name="jetbrains_powershell_script_file" dslName="path" mandatory="true">
<description>
A path to the script to run
</description>
</param>
</option>
<option name="script" value="CODE">
<description>
Run a PowerShell script with the given content
</description>
<param name="jetbrains_powershell_script_code" dslName="content" mandatory="true">
<description>
A PowerShell script content
</description>
</param>
</option>
</param>
<param name="jetbrains_powershell_execution" dslName="scriptExecMode" type="ExecutionMode">
<description>
PowerShell execution mode
@see ExecutionMode
</description>
</param>
<param name="jetbrains_powershell_noprofile" dslName="noProfile" type="boolean" trueValue="true" falseValue="">
<description>
Whether the script should be executed with the -NoProfile added
</description>
</param>
<param name="jetbrains_powershell_additionalArguments" dslName="args">
<description>
Additional arguments to be passed to PowerShell
</description>
</param>
<param name="jetbrains_powershell_scriptArguments" dslName="scriptArgs">
<description>
Build parameters to be passed as arguments into the PowerShell script
</description>
</param>
</params>
<types>
<enum name="Version">
<option name="Any" value=""/>
<option name="v1_0" value="1.0"/>
<option name="v2_0" value="2.0"/>
<option name="v3_0" value="3.0"/>
<option name="v4_0" value="4.0"/>
<option name="v5_0" value="5.0"/>
</enum>
<enum name="Platform">
<description>
A required platform bitness
</description>
<option name="x86" value="x86">
<description>
Require a 32-bit platform
</description>
</option>
<option name="x64" value="x64">
<description>
Require a 64-bit platform
</description>
</option>
</enum>
<enum name="ExecutionMode">
<description>
PowerShell script execution mode
</description>
<option name="STDIN" value="STDIN">
<description>
Run script using the -Command argument
</description>
</option>
<option name="PS1" value="PS1">
<description>
Run script with the -ExecutionPolicy ByPass argument to enable arbitrary scripts execution
</description>
</option>
</enum>
<enum name="Edition">
<description>
A PowerShell edition
</description>
<option name="Any" value="">
<description>
Use any edition
</description>
</option>
<option name="Core" value="Core">
<description>
Open-source edition based on .Net Core, cross-platform, 64-bit only
</description>
</option>
<option name="Desktop" value="Desktop">
<description>
Closed-source edition bundled with Windows, available only on Windows platforms.
</description>
</option>
</enum>
</types>
<examples>
<example>
<description>
A simple powershell script producing "Hello, World!" output to the build log.
</description>
<code>
powerShell {
scriptMode = script {
content = "Write-Host 'Hello, World!'"
}
}
</code>
</example>
<example>
<description>
Run a Powershell script with name "my_script.ps1" in the checkout directory.
Use cross-platform "Core" edition of the Powershell.
</description>
<code>
powerShell {
edition = PowerShellStep.Edition.Core
scriptMode = file {
path = "my_script.ps1"
}
}
</code>
</example>
</examples>
</dsl-extension>