IntelliJ Platform Plugin SDK Help

Verifying Plugin Compatibility

Please see Incompatible Changes in IntelliJ Platform and Plugins API for known breaking changes. For API annotated with ApiStatus.@Internal, see Internal API Migration for more details and replacements.

Plugin Verifier

Compatibility with newer IDEs can easily be verified for plugins hosted on the JetBrains Marketplace using the built-in Plugin Verifier.

Integration in Gradle build is available using the runPluginVerifier task, please see Gradle IntelliJ Plugin - Plugin Verifier for details.

You can easily integrate it within your CI by running this task as another quality check step. Check the IntelliJ Platform Plugin Template GitHub workflow configuration file as sample.

If your plugin is hosted on GitHub and you are not using Gradle, consider using third-party GitHub Actions IntelliJ Platform Plugin Verifier or IntelliJ Plugin Verifier.

For non-public plugins intellij-plugin-verifier can be used standalone as well.

IDE Support

Consider using the following IDE inspections to get additional alerts about code that uses unstable API features:

  • JVM languages | Unstable API Usage

  • JVM languages | Unstable type is used in signature

Usage of Extension Points which are deprecated or annotated with org.jetbrains.annotations.ApiStatus @Experimental/@Internal is highlighted in plugin.xml files.

Last modified: 24 November 2022