Graphical Task Template Parameters¶

The following is a description of the parameters of the graphical pipeline task templates.

Git Clone¶

Shell¶

If you want to run shell commands, select this template. Multiple lines are supported.

Print Message¶

If you want to output some messages in the terminal, select this template.

Preserve Artifacts¶

Review¶

If this step is added, the pipeline will be paused when it runs to this task, and the creator and the users who are @ mentioned can choose to continue or terminate.

Notify¶

Using the notification step during pipeline execution allows you to send emails to specified people. You need to make sure that a mail server has been configured in Global Management and that the current Jenkins can access it.

Use Credentials¶

Using the credential component is a special step in graphical editing. If it is enabled, all steps defined in this stage will be nested in the using credential step.

Timeout¶

If the execution time of the current task exceeds the timeout period, the task will be aborted, and the pipeline status will become failed .

SVN¶

Collect Test Reports¶

Collect JUnit test reports, which must be in xml format. You can fill in multiple addresses, separated by commas.

SonarQube Configuration¶

If you need to use SonarQube to scan the code in the code repository, select this step. Before using it, make sure you have integrated a SonarQube instance and bound it to the current workspace.

Code Quality Gate¶

This step needs to be used together with the SonarQube Configuration step. After this step is defined, the pipeline execution will be paused, waiting for the SonarQube code scanning analysis to complete and return the quality gate status, so as to determine whether to terminate the current pipeline run.

In addition, in actual use, it needs to be used together with the Timeout step to wait for the return result of the SonarQube code scan, as follows:

steps {
    timeout(time: 1, unit: 'HOURS') {
        waitForQualityGate abortPipeline: true
    }
}

update-application (System Built-in Custom Step)¶

Through the custom step capability, updating the image of a workload under the current tenant is supported.

Note: currently this step requires creating a credential for the target cluster in advance, using that credential in the Add Credentials step, and setting the environment variable to KUBECONFIG before it can be used.

deploy-application (System Built-in Custom Step)¶

Through the custom step capability, deploying an application is supported. The prerequisite is that you need to prepare a git repository, and the repository contains the manifest file of the application.

Note: currently this step requires creating a credential for the target cluster in advance, using that credential in the Add Credentials step, and setting the environment variable to KUBECONFIG before it can be used.

docker-build (System Built-in Custom Step)¶

Through the custom step capability, building and pushing images is supported.

Usage¶

When pushing an image, this step requires a username/password to log in to the image repository, so there are currently the following two ways to use it:

• Credentials + docker build
• Environment variables + docker build

Credentials + docker build¶

1. Create the credential in advance, and use it in the Add Credentials step of the pipeline. Set the username variable to DOCKER_USERNAME and the password variable to DOCKER_PASSWORD.

   

2. Create the sub-step docker build and fill in the relevant parameters.

Environment Variables + docker build¶

Note: this way is not recommended, because the password will be exposed in the pipeline.

1. Add the variables DOCKER_USERNAME and DOCKER_PASSWORD in the environment variables module of the pipeline and set the corresponding information.

   

2. Create the step docker build and fill in the relevant parameters.

Comments