- 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
Show all
Configuring Parameters
You can create and configure pipeline parameters.
Procedure
- Log in to CodeArts Pipeline.
- Search for the target pipeline, click
in the Operation column, and click Edit.
- Switch to the Parameter Configuration tab page.
The following parameters are provided.
Basic Information
Description
Create now
Click Create now in the parameter list to add a parameter.
Name
Parameter name. You can change the parameter name.
NOTE:
The name of a custom parameter cannot be the same as that of a predefined parameter.
Parameter Type
Parameter types include string, auto-increment, and enumeration.
Default
Enter or select a parameter value.
Runtime Setting
If Runtime Setting is enabled, the value of this parameter can be changed during pipeline execution.
Private Parameter
If a parameter is private, the system encrypts the input for storage and only decrypts the parameter when using it. Private parameters are not displayed in run logs.
Parameter Description
Description of a parameter.
Operation
Click
to delete a parameter.
- Add and configure parameters.
Click Create now in the parameter list area to set the name, type (String by default), and value of a new parameter. You can also set it as a private parameter or enable or disable runtime setting.
- String
The parameter value is a string. You can customize the value in the Default column, and enable Private Parameter or Runtime Setting.
- Enumeration
After you select Enumeration, the Enumeration dialog box is displayed. You can set Optional value.
After the setting is complete, click the Default drop-down list box to select a value. Alternatively, click
next to the parameter value to change the value.
- Auto-increment
The parameter value is a string and defaults to 1.0.0. If such a parameter is referenced by a task in the pipeline, the value of this parameter is incremented by 1 each time the pipeline is run.
NOTE:
If the value of an auto-increment parameter does not end with a digit, the value does not increase automatically after an execution.
- String
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.