IntelliJ Platform SDK DevGuide

Edit page

Incompatible Changes in IntelliJ Platform and Plugins API

IntelliJ API may be occasionally changed between releases, leading to incompatibilities of existing plugins with newer IDE builds.

Verifying Compatibility

Plugin Verifier

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

For local verification or non-public plugins, intellij-plugin-verifier can be used standalone as well. Integration in Gradle build is currently possible via some additional scripts, please see this issue for details.

If your plugin is hosted on GitHub, it is also readily made available via these GitHub Actions:

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

Known Breaking Changes

The following pages list the breaking changes in IDE/plugin releases with required/recommended steps to take by plugin authors.

Last modified: 14 May 2020