# Verifying Plugin Compatibility Tooling for ensuring compatibility. See [](api_changes_list.md) for known breaking changes. For API annotated with [`@ApiStatus.Internal`](%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), see [](api_internal.md) for more details and replacements. See also [](build_number_ranges.md#multipleIDEVersions). ## Plugin Verifier **Current Release**: %plugin-verifier-version% **GitHub**: [Releases & Changelog](https://github.com/JetBrains/intellij-plugin-verifier/releases), [Issue Tracker](https://youtrack.jetbrains.com/issues/MP?q=%23%7BPlugin%20Verifier%7D%20) **JetBrains Platform Forum**: [Plugin Verifier](https://platform.jetbrains.com/c/intellij-platform/plugin-verifier/7) category ### Using with Gradle Integration in [Gradle build](creating_plugin_project.md) is available out-of-the box via dedicated Gradle tasks. Use [`verifyPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin) task. Use [`runPluginVerifier`](tools_gradle_intellij_plugin.md#tasks-runpluginverifier) task. Integration with Continuous Integration (CI) environments is as simple as running the corresponding Gradle task as another quality check step. See the IntelliJ Platform Plugin Template [GitHub workflow configuration file](https://github.com/JetBrains/intellij-platform-plugin-template/blob/main/.github/workflows/build.yml) as reference. #### Navigation in the IDE Reported places are highlighted and linked to the plugin's source code in the Gradle tool window output (2023.3+). ### JetBrains Marketplace Compatibility with newer IDEs can easily be verified for plugins hosted on the [JetBrains Marketplace](https://plugins.jetbrains.com) using the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/). ### Other Usages If a plugin is hosted on GitHub and the project is _not_ using Gradle, consider using third-party GitHub Actions [IntelliJ Platform Plugin Verifier](https://github.com/marketplace/actions/intellij-platform-plugin-verifier) or [IntelliJ Plugin Verifier](https://github.com/marketplace/actions/intellij-plugin-verifier). In all other cases, [intellij-plugin-verifier](https://github.com/JetBrains/intellij-plugin-verifier) can be used standalone as well. ## IDE Support The status of an API is marked using various annotations defined in [`ApiStatus`](%gh-java-annotations%/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), please see their doc for more details. Use highlighting available via dedicated [IDE inspections](https://www.jetbrains.com/help/idea/code-inspection.html) as noted below to prevent problems as early as possible. ### Unstable API - `@ApiStatus.Experimental` is considered unstable and may break or be removed. - `@ApiStatus.Internal` must not be used by plugins, see [](api_internal.md) for more details and replacements. - `@ApiStatus.ScheduledForRemoval` denotes API that will be removed in a future version. Inspection: JVM languages | Unstable API Usage and JVM languages | Unstable type is used in signature ### Obsolete API API annotated with `@ApiStatus.Obsolete` has been replaced with a better alternative and must not be used for new code. Inspection: Plugin DevKit | Code | Usages of ApiStatus.@Obsolete (2023.1) ### Non-Extendable API API annotated with `@ApiStatus.NonExtendable` must not be extended, implemented or overridden. Inspection: JVM languages | Class, interface, or method should not be extended ### Override-Only API API annotated with `@ApiStatus.OverrideOnly` must not be called directly by the client. Inspection: JVM languages | Method can only be overridden ### plugin.xml Usage of [Extension Points](plugin_extensions.md) which are deprecated or annotated with `@ApiStatus.Experimental` or `@ApiStatus.Internal` is also highlighted in [plugin.xml](plugin_configuration_file.md) files. Inspection: Plugin DevKit | Plugin descriptor | Plugin.xml validity ### API Compatibility A plugin might specify a [compatibility range](build_number_ranges.md) including releases where some API is not available. Under the hood, it uses an artifact containing generated data via `@ApiStatus.AvailableSince`, which is automatically attached to the project. > If values are not specified directly in [plugin.xml](plugin_configuration_file.md) (e.g., when providing values via `patchPluginXml` Gradle task (Reference: [2.x](tools_intellij_platform_gradle_plugin_tasks.md#patchPluginXml), [1.x](tools_gradle_intellij_plugin.md#tasks-patchpluginxml))), they must be set explicitly in the inspection's settings. Inspection: Plugin DevKit | Code | Usage of IntelliJ API not available in older IDEs