| title |
|---|
Incompatible Changes in IntelliJ Platform and Plugins API |
IntelliJ API may be occasionally changed between releases, leading to existing plugins' incompatibilities with newer IDE builds.
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 possible using the runPluginVerifier task, please see Gradle IntelliJ Plugin - Plugin Verifier DSL for details.
You can easily integrate it within your CI by running that 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 the following third-party GitHub Actions:
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
TIP Follow JBPlatform on Twitter and visit JetBrains Platform Blog for the latest announcements.
The following pages list the breaking changes in IDE and plugin releases with required/recommended steps to take by plugin authors.
- Changes in 2021.*
- Changes in 2020.*
- Changes in 2019.*
- Changes in 2018.*
- Changes in 2017.*
- Changes in 2016.*
NOTE Changes from API marked with
org.jetbrains.annotations.ApiStatus.@Experimental/ScheduledForRemovalare not listed here, as incompatible changes are to be expected.