Updated on 2024-05-08 GMT+08:00

Registering a Basic Extension

  1. Log in to the CodeArts homepage.
  2. Choose Services > Extensions from the top navigation bar.
  3. Click .
  4. Set basic information. For details, see Table 1.

    Table 1 Parameter description

    Parameter

    Description

    Icon

    Icon of the extension. Upload an image in PNG, JPEG, or JPG format, with a file size no more than 512 KB (recommended: 128 x 128 pixels). If no image is uploaded, the system generates an icon.

    Name

    Name of the extension.

    Unique Identifier

    ID of the extension. Once set, this parameter cannot be changed.

    Type

    Type of the extension, which can be Build, Check, Test, Deploy, or Normal. Once set, this parameter cannot be changed.

    Description

    Purposes and functions of the extension. The description can be edited.

    Some information must be the same as that of the extension uploaded in step 6. For details, see Extension Properties.

  5. Click OK.
  6. On the displayed page, click . In the displayed dialog box, select the desired extension (with input definition and execution script) and upload it. After the upload is successful, the version will be marked with Draft.

  7. Debug the extension.

    Create a pipeline. On the Task Orchestration page, create a job, add the registered basic extension, and set parameters.

  8. Save and execute the pipeline. After the execution is complete, click the extension name to view the execution result.

  9. (Optional) After debugging, publish the extension as an official version.

    1. Go to the extension page.
    2. Click the registered basic extension.
    3. On the displayed page, click on the right to publish the version as an official version.

    The draft version can be overwritten for multiple times. However, the official version cannot be updated. You can click Upload plug-in in the upper right corner to upload a new version. As shown in the following figure, version 0.0.1 is an official version, and version 0.0.2 is an uploaded draft version.