-
Notifications
You must be signed in to change notification settings - Fork 142
Publishing Extensions
This guide describes publishing to the public registry at open-vsx.org, which is now managed by the Eclipse Foundation (see the announcement).
Similar steps may apply to registries that are hosted elsewhere, but make sure to pass the correct URL to the ovsx tool.
If you are the author of the extension you wish to publish, proceed with the steps below. If you are not the author, we suggest you first reach out to the author with an issue in their GitHub repo to request that they publish their extension to open-vsx.org. We've drafted a template with suggested content for the issue.
An eclipse.org account is necessary to sign a Publisher Agreement with the Eclipse Foundation. Use this form to register. It is important to fill in the GitHub Username field and to use exactly the same GitHub account as when you log in to open-vsx.org.
Log in to open-vsx.org: click on the account icon on the top right corner, then authorize the application with your GitHub account.
Navigate to the open-vsx.org Profile page (click on your avatar → Settings). Click on Log in with Eclipse and then authorize the application to access your eclipse.org account.
If the Eclipse login process is successful, you will see a button labeled Show Publisher Agreement on your open-vsx.org profile page. Click that button, read the agreement text to the bottom and click Agree if you consent to publishing under these terms.
Note that the "Eclipse Contributor Agreement" (ECA) is a different agreement used to contribute code to Eclipse open-source projects.
Navigate to the open-vsx.org Access Tokens page (click on your avatar → Settings → Access Tokens).
Click Generate New Token and enter a description. We recommend to generate a new token for each environment where you want to publish, e.g. a local machine, cloud IDE, or CI build. The description will help you to identify a token in case you want to revoke it (you don't need it anymore or you suspect it has been stolen).
Click Generate Token and copy the generated value to a safe place, e.g. an encrypted file or the secret variables of your cloud IDE / CI settings. Note that the value is never displayed again after you close the dialog! In case you lose a token, delete it and generate a new one.
An access token can be used to publish as many extensions as you like, until it is deleted.
The publisher field in your extension's package.json file defines the namespace in which the extension will be made available. You need to create the namespace in the registry before any extension can be published to it. This is done with the ovsx CLI tool. The easiest way to use it is through npx, which makes sure you always use the latest version of the tool. Alternatively, install it globally with npm i -g ovsx.
Run the following command, replacing <name> with the value of your extension's publisher and replacing <token> with the previously generated access token value.
npx ovsx create-namespace <name> -p <token>
Creating a namespace does not automatically assign you as verified owner. If you want the published extensions to be marked as verified, you can claim ownership of the namespace.
The publishing process involves the two steps package and upload. Both can be done with the same ovsx CLI tool that is used to create a namespace.
If you have an already packaged .vsix file, you can publish it by simply running the following command, replacing <file> with the path to your extension package and replacing <token> with the previously generated access token value.
npx ovsx publish <file> -p <token>
In order to build and publish an extension from source, first make sure to prepare the project accordingly, typically by running npm install or yarn. Then run the following command in the root directory of the extension.
npx ovsx publish -p <token>
The ovsx tool uses vsce internally to package extensions, which runs the vscode:prepublish script defined in the package.json as part of that process. If the extension uses Yarn to run scripts, add the argument --yarn.
If the ovsx tool reported that publishing was successful, you should find your extension on open-vsx.org. Please check all metadata for correctness.
You can find a GitHub action that allows publishing to Open VSX at HaaLeo/publish-vscode-extension.