Back to Top

Get Jenkins Job Status

Class Name com.midvision.rapiddeploy.plugins.build.jenkins.task.GetJobStatus
Category Jenkins

Get Jenkins Job Status

Description

Get the status of a Jenkins Job. Write the status to the corresponding output parameter for use in later tasks.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
buildStartTime java.lang.String ${buildStartTime} false The name of the output parameter, which can pass the return value from the task. The task output will be the Jenkins jobs last build start time. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${buildStartTime}.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
jenkinsJobName java.lang.String Job false The Jenkins job to invoke.
jenkinsUrl java.lang.String http://localhost/jenkins false The remote Jenkins URL
jobStatus java.lang.String ${jobStatus} false The name of the output parameter, which can pass the return value from the task. The task output will be the Jenkins job status. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${jobStatus}.
lastBuildSuccess java.lang.String ${lastBuildSuccess} false The name of the output parameter, which can pass the return value from the task. The task output will be the Jenkins jobs last build success status. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${lastBuildSuccess}.
password java.lang.String   false Password to use to authenticate when connecting to Jenkins (if required).
rawJobData java.lang.String ${rawJobData} false The name of the output parameter, which can pass the return value from the task. The task output will be the raw job data. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${rawJobData}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username to use to authenticate when connecting to Jenkins (if required).


Back to Top

Get Job Config

Class Name com.midvision.rapiddeploy.plugins.build.jenkins.task.GetJobConfig
Category Jenkins

Get Jenkins Job Configuration

Description

Return the Job Configuration for the given job, as XML.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
jenkinsJobName java.lang.String Job false The Jenkins job to invoke.
jenkinsUrl java.lang.String http://localhost/jenkins false The remote Jenkins URL
jobConfig java.lang.String ${jobConfig} false The name of the output parameter, which can pass the return value from the task. The task output will be the Jenkins job configuration in XML format. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${jobConfig}.
password java.lang.String   false Password to use to authenticate when connecting to Jenkins (if required).
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username to use to authenticate when connecting to Jenkins (if required).


Back to Top

Invoke a Jenkins Job

Class Name com.midvision.rapiddeploy.plugins.build.jenkins.task.InvokeJob
Category Jenkins

Invoke a Jenkins Job

Description

Run a Jenkins Job from RapidDeploy. Optionally, wait for the job to complete.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
jenkinsJobName java.lang.String Job false The Jenkins job to invoke.
jenkinsUrl java.lang.String http://localhost/jenkins false The remote Jenkins URL
password java.lang.String   false Password to use to authenticate when connecting to Jenkins (if required).
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username to use to authenticate when connecting to Jenkins (if required).
waitForBuild java.lang.Boolean false false This task will wait for the build to complete if set to true. If set to false (the default), the build will be executed asynchronously.


Back to Top

Set Job Config

Class Name com.midvision.rapiddeploy.plugins.build.jenkins.task.SetJobConfig
Category Jenkins

Set Jenkins Job Configuration

Description

Set the Job Configuration for the given job, as XML.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
jenkinsJobName java.lang.String Job false The Jenkins job to invoke.
jenkinsUrl java.lang.String http://localhost/jenkins false The remote Jenkins URL
jobConfig TextArea   false THe Job Configuration to set. Enter the XML here to set for the job configuration etc.
password java.lang.String   false Password to use to authenticate when connecting to Jenkins (if required).
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username to use to authenticate when connecting to Jenkins (if required).