Updated on 2023-11-28 GMT+08:00

Configuring Parameters

You can create and configure pipeline parameters.

Procedure

  1. Log in to CodeArts Pipeline.
  2. Search for the target pipeline, click in the Operation column, and click Edit.
  3. 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.

  4. 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.

      If the value of an auto-increment parameter does not end with a digit, the value does not increase automatically after an execution.