Creating a Pipeline with the GUI

Preparations

• Create a project.
• If you use a CodeArts Repo repository, create a code repository.
• If you want to enhance permissions to do operations on Repo or connect to a third-party repository, create a service endpoint.

Creating a Pipeline

1. Access the CodeArts Pipeline homepage.
2. Click Create Pipeline. Configure parameters by referring to Table 1.

   Table 1 Pipeline basic information

   Parameter	Description
   Name	Enter a pipeline name. Enter only letters, digits, underscores (_), and hyphens (-) with a maximum of 128 characters.
   Project	Project that a pipeline belongs to. If you access CodeArts Pipeline through the homepage, select a project as needed. If you access CodeArts Pipeline through a project, the parameter cannot be changed.
   Code Source	Code source associated with the pipeline: CodeArts Repo: provides comprehensive code hosting services for enterprises and Git-based online code hosting services for software developers. Third-party code source GitLab: After connecting to a GitLab account, you can obtain the repository and branch information of that account. Git: After connecting to a Git repository, you can obtain its branch information. SoftWare Repository for Container (SWR) Use SWR as the pipeline source to run the pipeline and generate system parameters such as the artifact name, download address, and version number for extensions. NOTE: GitLab code source is available in LA-Mexico City2, LA-Sao Paulo1, and AP-Singapore regions. If you do not need to associate the pipeline with a code repository, you can select None. In this case, executing a job that should be associated with a repository will result in an error. For details, see FAQs.
   Orchestration Method	If you select Repo as the code source, you can choose either of the following ways to orchestrate a pipeline. Graphical: Uses the GUI to clearly display serial and parallel jobs. YAML: Uses YAML (One YAML file can be used for multiple pipelines). Syntax auto-completion and validation available. For details, see Creating a Pipeline with YAML.
   Service Endpoint	You need to use a service endpoint to connect to a third-party repository. Select an endpoint created in Preparations or click Create one to create an endpoint. For details, see Creating Service Endpoints.
   Repository	Code repository associated with the pipeline.
   Default Branch	Branch used when a pipeline is executed manually or at a specified time.
   Repo Endpoint	Configure an endpoint to enhance permissions for Repo. Endpoints are used for change-triggered pipelines and repository operation extensions. You can select an endpoint created in Preparations or click Create one to create an endpoint. For details, see Creating Service Endpoints.
   Alias	After you set a repository alias, system parameters will be generated based on the alias. For example, Alias_REPOSITORY_NAME indicates the repository name. You can check the generated parameters on the Parameter Configuration page and reference them in a pipeline in the format of ${Parameter name}. Enter only letters, digits, and underscores (_) with a maximum of 128 characters.
   Description	Enter a maximum of 1,024 characters.
   Organization	If Code Source is set to SWR, select the SWR organization. Organizations isolate and manage images within each company or department.
   Image Name	If Code Source is set to SWR, select an image in the organization.
   Specified Version	Image version selected for the SWR code source.
   Source Alias	After you set an artifact source alias, system parameters will be generated based on the alias. For example, Alias_ARTIFACT_NAME indicates the artifact name. You can check the generated parameters on the Parameter Configuration page and reference them in a pipeline in the format of ${Parameter name}. Enter only letters, digits, underscores (_), hyphens (-), and periods (.) with a maximum of 128 characters.

3. After configuring the basic information, click Next. The Select Template page is displayed.
   • You can select a system or custom template to quickly create a pipeline. Jobs will be automatically generated based on the selected template. For more information, see Managing Pipeline Templates.
   • You can also select Blank Template to create a pipeline from scratch.

4. Click OK to create a pipeline.

   The Task Orchestration page is displayed. You can configure the pipeline or click Cancel to return to the pipeline list.

Managing Pipeline Templates

CodeArts Pipeline provides system templates and allows you to customize templates. You can use templates to quickly create continuous delivery pipelines and standardize the delivery process.

• Access the template list via:
  • Homepage: Access the Pipeline homepage, and switch to the Templates tab page.
  • A project: Access the pipeline list in a project, click More > Templates in the upper right corner.

  You can perform the following operations on templates.

  Table 2 Operations on templates

  Parameter	Description
  	Click this icon, you will be redirected to the page where you can quickly create a pipeline using a template.
  	Click this icon to favorite a template. After a template is favorited, the icon changes to . You can click to unfavorite the template.
  	Click this icon and select Edit. On the displayed Task Orchestration tab page, you can edit the template. Click this icon and select Clone. On the displayed Task Orchestration tab page, you can clone the template. Click this icon and select Delete to delete the template as prompted. NOTE: System templates are used to clone or generate pipelines. They cannot be edited or deleted.

• Customize a pipeline template
  1. Access the template list.
  2. Click Create Pipeline Template. The Task Orchestration page is displayed.
  3. Configure basic information, stages/jobs, and parameters.
     • Basic Information: Specify the template name, language (Java, Python, Node.js, Go, .Net, C++, PHP), and description (optional). Language is None by default.
     • Task Orchestration: Pipeline stages and some extensions can be added to a pipeline template. After jobs such as build, code check, deployment, and API test are configured in a template, corresponding jobs will be created when you create a pipeline using this template.
       

       • Code source is not required for a template.
       • Stage entry configuration is not supported for template orchestration.
     • Parameter Configuration: Add parameters to the template. Pipeline template parameters include custom and predefined parameters. Custom parameters include string, enumeration, and auto-increment types. For details about how to configure parameters, see Configuring Custom Parameters.
  4. Click Save to complete the template creation.