Creating an Extension by Uploading an Extension Package

Preparing an Extension Package

Extension package

File structure

extension.zip                          # ZIP package of the extension
   | -- scripts                        # (Optional) Script folder for storing scripts that contain extension execution logic.
   |    | -- xxx                       # Script that contains extension execution logic
   | -- i18n                           # (Optional) Contents in multiple languages
   |    | -- zh-cn                     # Contents in Chinese environment
   |         | -- resources.json       # Internationalization resources
   |    | -- en-us                     # Contents in English environment
   |         | -- resources.json       # Internationalization resources
   | -- codearts-extension.json        # (Mandatory) Extension execution file (in JSON format), including basic information, inputs, and execution

Notes:

• The extension package must be in the ZIP format.
• The root directory of the package must contain a metadata file codearts-extension.json. For more information about the file, see codearts-extension.json.
• The resources.json file can be encoded only using UTF-8.

Creating an Extension

1. Access the CodeArts Pipeline homepage.
2. On the CodeArts Pipeline homepage, choose Services > Extensions.
3. Click .
4. Set basic information. For details, see Table 1.

   Table 1 Extension information

   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	The extension name displayed in the extension platform. Enter only spaces, letters, digits, underscores (_), hyphens (-), and periods (.) with a maximum of 50 characters.
   Unique Identifier	ID of the extension. This value should be consistent with the name field of the codearts-extension.json file. Once set, this parameter cannot be changed. Enter only letters, digits, underscores (_), and hyphens (-) with a maximum of 50 characters. Mapping between the extension type and the value of category: Build: Build Check: Gate Deploy: Deploy Test: Test Normal: Normal
   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. Enter no more than 1,000 characters.

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.
   Figure 1 Uploading an extension
   

7. Using an extension in a pipeline

   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.

codearts-extension.json

{
    "type": "Task",
    "name": "demo_plugin",
	"friendlyName": "Extension name",
	"description": "This is an extension.",
    "category": "Gate",
    "version": "0.0.2",
	"versionDescription": "Updated based on the initial version 0.0.1",
    "dataSourceBindings": [],
    "inputs": [
        {
	"name": "samplestring",                              # Use ${samplestring} in a script to obtain the value configured by an executor in a pipeline
	"type": "input",                                     # Different types correspond to different functions
	"description": "Sample String",                      # Description of input
	"defaultValue": "00",                                # Default value when the value of the required field is false
	"required": true,                                    # Reset defaultValue if the required field is true, or the default value will be used
            "label": "Text box",                                # input information displayed on the pipeline editing page
            "validation": {
                "requiredMessage": "Enter a value",                    # (Optional) The message displayed when the required field is left blank
                "regex": "^[a-zA-Z0-9-_\\u4e00-\\u9fa5]{1,32}$", #(Optional) RegEx validation
                "regexMessage": "Type error"                       # (Optional) The message displayed when RegEx validation failed
            }
        }
    ],
    "execution": {
        "type": "Shell",
        "target": "scripts/execution.sh"
    },
    "outputs": [{
			"name": "okey",                          # Output name.
			"type": "output",                        # Output type: output or metrics.
			"description": "Description",
			"prop": {
				"defaultValue": "123"            # Default value
			}
		},
		{
			"name": "mkey",
			"type": "metrics",
			"description": "Description",
			"prop": {
				"defaultValue": "213",
				"group": "213"                   # Corresponding to the group name in pass conditions
			}
		}
	]
}

The parameters of codearts-extension.json are described in the following table.