The plug-in meta information is required to publish a VS Code extension in an Eclipse Che plug-in registry. This meta information is provided as a meta.yaml file. This section describes how to create a meta.yaml file for an extension.

Procedure

  1. Create a meta.yaml file in the following plug-in registry directory: <apiVersion>/plugins/<publisher>/<plug-inName>/<plug-inVersion>/.

  2. Edit the meta.yaml file and provide the necessary information. The configuration file must adhere to the following structure:

    apiVersion: v2                                                   (1)
publisher: myorg                                                 (2)
name: my-vscode-ext                                              (3)
version: 1.7.2                                                   (4)
type: value                                                      (5)
displayName:                                                     (6)
title:                                                           (7)
description:                                                     (8)
icon: https://www.eclipse.org/che/images/logo-eclipseche.svg     (9)
repository:                                                     (10)
category:                                                       (11)
spec:
  containers:                                                   (12)
    - image:                                                    (13)
      memoryLimit:                                              (14)
  extensions:                                                   (15)
    - https://github.com/redhat-developer/vscode-yaml/releases/download/0.4.0/redhat.vscode-yaml-0.4.0.vsix
    - vscode:extension/SonarSource.sonarlint-vscode
    1 Version of the file structure.
    2 Name of the plug-in publisher. Must be the same as the publisher in the path.
    3 Plug-in name. Must be the same as in path.
    4 The Che plug-in version. Must be the same as in path.
    5 Type of the Che plug-in. For VS Code extensions, it must be VS Code extension.
    6 A short name of the plug-in.
    7 Plug-in title.
    8 A brief explanation of the plug-in and what it does.
    9 The link to the plug-in logo.
    10 Optional. The link to the source-code repository of the plug-in.
    11 Defines the category that this plug-in belongs to. Should be one of the following: Editor, Debugger, Formatter, Language, Linter, Snippet, Theme, or Other.
    12 If this section is omitted, the VS Code extension is added into the Che-Theia IDE container.
    13 The Docker image from which the sidecar container will be started. Example: eclipse/che-theia-endpoint-runtime:next.
    14 The RAM which is given for the sidecar container by default. Example: "256Mi". This value might be overridden by the user in the component configuration.
    15 A list of VS Code extensions that should be run in this sidecar container.