CodeArts Pipeline
CodeArts Pipeline
- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Template management
-
Pipeline Management
- Execute Pipeline
- Obtaining Pipeline Status in Batches
- Obtaining the Pipeline Status/Obtaining Pipeline Execution Details
- Obtaining the Pipeline List/Obtaining the Pipeline Execution Status of a Project
- Deleting a Pipeline
- Stopping a Pipeline
- Obtaining Pipeline Execution Records
- Creating a Pipeline Using a Template
- Creates a pipeline.
- Re-trial Run Pipeline
- Pass the manual review.
- Reject to Manual Review
- Querying Pipeline Logs
- Manage by group
- Rule Management
- Tenant-level policy management
- Project-level policy management
-
Tenant-level open source governance policy management
- Creating a Tenant-Level Open Source Governance Policy
- Modifying a Tenant-Level Open Source Governance Policy
- Querying Details About a Tenant-Level Open Source Governance Policy
- Querying the Tenant-Level Open Source Governance Policy List
- Deleting a Tenant-Level Open Source Governance Policy
- Changing the Enabling Status of a Tenant-Level Open Source Governance Policy
- Project-level open source governance policy management
-
Extension Plug-in Management
- Creating a Plug-in Version
- Creating a Plug-in Draft Version
- Creating a publisher
- Update Plug-in Draft
- Releasing a Plug-in Draft
- Updating Basic Plug-in Information
- Releasing a Plug-in
- Binding a Plug-in to a Publisher
- Updating the Plug-in Icon
- Updating the Publisher Icon
- Deleting a Plug-in Draft
- Querying the Publisher List
- Querying Available Publishers
- Querying the List of Optional Plug-ins
- Querying the Basic Plug-in List
- Querying the List of Optional Plug-ins in Pagination Mode
- Listing add-ons
- Query Plug-in Indicator Configuration
- Query Plug-in Input Configuration
- Query Plug-in Output Configuration
- Querying All Plug-in Version Information
- Querying Plug-in Version Details
- Querying the Plug-in Version
- Deleting a publisher
- Querying Publisher Details
- Creating a Basic Plug-in
- Updating Basic Plug-ins
- Deleting a Basic Plug-in
- Uploading Basic Plug-ins
- Querying Basic Plug-in Details
- Appendixes
- Change History
-
FAQs
- Functions
-
Troubleshooting
- The Pipeline Parameter Referenced by the Task Does Not Exist
- Test Suite Was Running
- Failed to Obtain Tenant Information During Code Check Task Execution
- The Pipeline That Does Not Listen to the Push Event Is Triggered When the Code Is Committed
- Scheduled Task of a Pipeline Was Not Triggered
- Run Button Was Unavailable
On this page
Configuring a Pipeline Template
Updated on 2023-11-28 GMT+08:00
You can configure a pipeline template to quickly generate a pipeline. You can access the template page in the following ways.
- Homepage: Access CodeArts Pipeline. On the Pipelines tab page that is displayed, switch to the Templates tab page.
- Project: Access the pipeline of a project and choose More > Templates in the upper right corner.
Template Types
CodeArts Pipeline supports system and custom templates.
The operations on the template list are as follows:
Operation |
Description |
---|---|
|
Click this icon and the Create Pipeline page is displayed. |
|
Click this icon to follow a template. After a template is followed, the icon changes to |
|
|
System templates are used to copy or generate pipelines. They cannot be edited or deleted.
Creating or Configuring a Template
- Access the Templates tab page.
- Click Create Pipeline Template. The Task Orchestration tab page is displayed.
Configure basic template information, template stages/tasks, and template parameters as required.
- Basic Information: Specify the template name (mandatory), language (Java, Python, Node.js, Go or None (default)), and description (optional).
- Pipeline Source: You do not need to set this parameter.
- Stage Entry: Stage entry is not supported during template orchestration.
- Task Orchestration: Currently, pipeline stages and some extensions can be added to a pipeline template. After tasks such as build, code check, deployment, and API test are configured in the template, corresponding tasks will be created when a pipeline is created using this template.
- Parameter Configuration: Switch to the Parameter Configuration tab page and add parameters to the template as required. 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 Managing Parameters.
- After configuring the information, click Save.
Creating a Pipeline
- On the Templates page, search for the target template, and click
in the Operation column.
- On the Basic Information page, select a project, enter a pipeline name, select a pipeline source as needed, set related parameters, and click OK.
- The Task Orchestration page is displayed.
- You can customize the template content or directly click Save.
- For the pipeline generated using the template, tasks mounted to it are automatically generated by the system. To mount custom tasks to the pipeline, manually add them after the pipeline is generated.
- After configuring the information, click Save.
Parent topic: Pipeline Management
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
The system is busy. Please try again later.