publish-extensions's Introduction

Publish Extensions to Open VSX

A CI for publishing open-source VS Code extensions to https://open-vsx.org

How to Add an Extension?

To automatically publish an extension to Open VSX, simply add it to extensions.json.

You can also run node add-extension [REPOSITORY] to add it automatically.

Publishing Options

Here is the expected format of an extensions.json entry:

    {
      // Unique Open VSX extension ID in the form "<namespace>.<name>"
      "id": "redhat.vscode-yaml",
      // Repository URL to clone and publish from
      "repository": "https://github.com/redhat-developer/vscode-yaml"
    },

Here are all the supported values, including optional ones:

    {
      // Unique Open VSX extension ID in the form "<namespace>.<name>"
      "id": "ms-vscode.cpptools",
      // (OPTIONAL) The version to publish to Open VSX (defaults to the package.json version)
      "version": "0.26.3",
      // Repository URL to clone and publish from
      "repository": "https://github.com/microsoft/vscode-cpptools",
      // (OPTIONAL) The Git branch, tag, or commit to check out before publishing (defaults to the repository's default branch)
      "checkout": "0.26.3",
      // (OPTIONAL) Location of the extension's package.json in the repository (defaults to the repository's root directory)
      "location": "Extension"
    },

How are Extensions Published?

Every night at 03:03 UTC, a GitHub workflow goes through all entries in extensions.json, and checks if the specified "version" needs to be published to https://open-vsx.org or not.

The publishing process can be summarized like this:

git clone "repository"
(git checkout "checkout" if a "checkout" value is specified)
npm install (or yarn install if a yarn.lock file is detected in the provided "location")
(ovsx create-namespace "publisher" if it doesn't already exist)
ovsx publish (with --yarn if a yarn.lock file was detected earlier)