Help Center/ CodeArts Pipeline/ User Guide/ Configuring a Pipeline/ Configuring Pipeline Extensions/ JenkinsTask
Updated on 2025-08-13 GMT+08:00
View PDF
Share

JenkinsTask

Call Jenkins tasks.

Notes and Constraints

Currently, this function is available in LA-Mexico City2, LA-Sao Paulo1, and AP-Singapore.

Adding the Extension with GUI

Add the JenkinsTask extension when you orchestrate a pipeline. Set parameters as shown in Table 1.

Table 1 Parameter description

Parameter

Description

Name

Extension name, which can be customized.

  • Enter only letters, digits, hyphens (-), underscores (_), commas (,), semicolons (;), colons (:), periods (.), slashes (/), parentheses (), and spaces.
  • Enter 1 to 128 characters.

Jenkins Endpoint

Create a Jenkins service endpoint by referring to Jenkins.

jobName

Jenkins job name.

params

Parameters (in JSON format) transferred for starting the job.

Asynchronous

Whether to execute the job asynchronously.

Description

Description for connecting to the endpoint.

Adding the Extension with YAML

Add the JenkinsTask extension when you orchestrate a pipeline. Configure the YAML syntax as follows:

  • JenkinsTask 
    uses: Jenkins
with:
  endpoint: eac965b206e74e2b898a24a4375b6df6
  jobName: job
  params: '{ \"key\":\"value\" }'
  async: true|false
  description: description
    • endpoint: ID of the Jenkins endpoint.
    • jobName: Jenkins job name.
    • params: Parameters (in JSON format) transferred for starting the job.
    • async: Whether to execute the job asynchronously.
    • description: Execution description.