Publishing a Plugin to a Custom Plugin Repository
If you intend to use a plugin repository other than the JetBrains Marketplace, you will need to:
Create and maintain an updatePlugins.xml file on the HTTPS web server you are using for your custom repository. This file describes all the plugins available in your custom repository and each plugin's download URL.
Upload your plugin JAR/ZIP file to an HTTPS web server. This can be the same web server you are using for the custom repository or a different HTTPS web server.
Add the URL for the custom repository to the JetBrains IDE Repository Settings/Preferences.
Describing Your Plugins in updatePlugins.xml File
Every custom plugin repository must have at least one updatePlugins.xml file to describe every hosted plugin's latest available version. The description in updatePlugins.xml is used by JetBrains IDEs to locate plugins by attributes such as id, IDE version, and plugin version. These attributes are displayed by JetBrains IDEs to help users select or upgrade plugins. The description also tells the JetBrains IDE where to download the plugin itself.
A custom plugin repository's updatePlugins.xml file is constructed and maintained by the repository administrator. More than one updatePlugins.xml file may be required if the custom repository consumers are using more than one version of a JetBrains IDE. For example, updatePlugins-182.xml, updatePlugins-183.xml for IntelliJ IDEA 2018.2 and 2018.3, respectively. Each updatePlugins-*.xml file will have a unique URL that is added to the JetBrains IDE Repository Settings/Preferences.
Format of updatePlugins.xml File
The format of an updatePlugins.xml file is simply a list of sequential elements that describe each plugin:
Note:
An updatePlugins.xml file must contain at least one set of
<plugin></plugin>
elements.A plugin
id
may be listed only once in an updatePlugins.xml file.Multiple plugins with the same
id
but differentidea-version
attributes must be split into separate updatePlugins-*.xml files. The requesting IDE's version is passed asbuild
parameter and can be used for server-side filtering.
Optional updatePlugin.xml Elements
Can additional elements be added to updatePlugins.xml? Yes, but it's advisable only if needed. The additional elements will have to be synchronized with each plugin's plugin.xml file.
During plugin installation, the IDE reads the plugin JAR/ZIP file, and thereafter displays more information about the plugin. What additional information might help a user select a plugin when browsing the custom plugin repository before installation? The answer depends on the plugins and repository consumers. Here are the candidate elements:
Element | Effects & Requirements |
---|---|
| By default the name of the plugin JAR/ZIP file is displayed before installation. |
| By default no description for the plugin is displayed before installation. |
| By default no change notes for the plugin are displayed before installation. |