jenkins.Build
Description unavailable
Type hierarchy: jenkins.Build > xlrelease.PythonScript > xlrelease.BasePythonScript > udm.BaseConfigurationItem
Label: Jenkins: Build
Properties
| Property | Kind | Description |
|---|---|---|
| customScriptTask | xlrelease.CustomScriptTask (parent) | Custom Script Task |
| jenkinsServer | jenkins.Server | Jenkins server to connect to |
| username | String | Overrides the username used to connect to the server |
| password | Password | Overrides the password used to connect to the server |
| jobName | String | Name of the job to trigger; this job must be configured on the Jenkins server. If the job is located in one or more Jenkins folders, add a ‘job’ segment between each folder. |
| jobParameters | String | If the Jenkins job expects parameters, provide them here, one parameter per line (for example, paramName=paramValue) |
| buildNumber | String | Build number of the triggered job |
| buildStatus | String | Build status of the triggered job |
| location | String | Location header returned by jenkins |
customScriptTask
Custom Script Task
- Label: Custom Script Task
- Kind: xlrelease.CustomScriptTask (parent)
- Required: false
- Reference type: xlrelease.CustomScriptTask
- As containment: true
jenkinsServer
Jenkins server to connect to
- Label: Server
- Kind: jenkins.Server
- Required: true
- Category: input
- Reference type: jenkins.Server
username
Overrides the username used to connect to the server
- Label: Username
- Kind: String
- Required: false
- Category: input
password
Overrides the password used to connect to the server
- Label: Password
- Kind: Password
- Password: true
- Required: false
- Category: input
jobName
Name of the job to trigger; this job must be configured on the Jenkins server. If the job is located in one or more Jenkins folders, add a ‘job’ segment between each folder.
- Label: Job Name
- Kind: String
- Required: true
- Category: input
jobParameters
If the Jenkins job expects parameters, provide them here, one parameter per line (for example, paramName=paramValue)
- Label: Job Parameters
- Kind: String
- Size: LARGE
- Required: false
- Category: input
buildNumber
Build number of the triggered job
- Label: Build Number
- Kind: String
- Required: false
- Category: output
buildStatus
Build status of the triggered job
- Label: Build Status
- Kind: String
- Required: false
- Category: output
location
Location header returned by jenkins
- Label: Location
- Kind: String
- Required: false
- Category: script
Hidden properties
| Property | Kind | Description |
|---|---|---|
| configurationUri | String | URI of the HTML file to render the task for custom script tasks |
| maxOutputPropertySize | Integer | Maximum size of output property values of type string. Default value is 32768 |
| iconClass | String | Icon Class |
| outputVarHelpText | String | Output Var Help Text |
| taskColor | String | Task Color |
| preconditionEnabled | Boolean | Indicates whether preconditions should be enabled |
| failureHandlerEnabled | Boolean | Indicates whether failure handler should be enabled |
| scriptLocation | String | Script Location |
| iconLocation | String | Icon Location |
configurationUri
URI of the HTML file to render the task for custom script tasks
- Key:
jenkins.Build.configurationUri - Kind: String
- Default value:
- Hidden: true
maxOutputPropertySize
Maximum size of output property values of type string. Default value is 32768
- Key:
jenkins.Build.maxOutputPropertySize - Kind: Integer
- Default value: 32768
- Hidden: true
iconClass
Icon Class
- Key:
jenkins.Build.iconClass - Kind: String
- Default value:
- Hidden: true
outputVarHelpText
Output Var Help Text
- Key:
jenkins.Build.outputVarHelpText - Kind: String
- Default value: The output of the script can be stored in release variables; specify the variables to be used (optional)
- Hidden: true
taskColor
Task Color
- Key:
jenkins.Build.taskColor - Kind: String
- Default value: #009CDB
- Hidden: true
preconditionEnabled
Indicates whether preconditions should be enabled
- Key:
jenkins.Build.preconditionEnabled - Kind: Boolean
- Default value: true
- Hidden: true
failureHandlerEnabled
Indicates whether failure handler should be enabled
- Key:
jenkins.Build.failureHandlerEnabled - Kind: Boolean
- Default value: true
- Hidden: true
scriptLocation
Script Location
- Key:
jenkins.Build.scriptLocation - Kind: String
- Default value: jenkins/Build.py
- Hidden: true
iconLocation
Icon Location
- Key:
jenkins.Build.iconLocation - Kind: String
- Default value: jenkins/jenkins.png
- Hidden: true