hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

api_changes_list.md: Ensuring compatibility, GH actions, Gradle solution

Browse Source
This commit is contained in:
Yann Cébron 2020-04-16 18:23:29 +02:00
parent bd09bbce43
commit 2a4b503eb0
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
reference_guide/api_changes_list.md
View File

@ -69,15 +69,26 @@ IntelliJ API may be occasionally changed between releases, leading to incompatib
Therefore, it is important to keep your plugins up to date with regard to the existing and upcoming API changes. Therefore, it is important to keep your plugins up to date with regard to the existing and upcoming API changes.
--> -->
## Verifying Compatibility
### Plugin Verifier
Compatibility with newer IDEs can easily be verified for plugins hosted on the [JetBrains plugin repository](/plugin_repository/index.md) using the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/). Compatibility with newer IDEs can easily be verified for plugins hosted on the [JetBrains plugin repository](/plugin_repository/index.md) using the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/).
For non-public plugins, [intellij-plugin-verifier](https://github.com/JetBrains/intellij-plugin-verifier) can be used standalone as well. For local verification or non-public plugins, [intellij-plugin-verifier](https://github.com/JetBrains/intellij-plugin-verifier) can be used standalone as well.
Integration in [Gradle build](/tutorials/build_system.md) is currently possible via some additional scripts, please see [this issue](https://github.com/JetBrains/gradle-intellij-plugin/issues/385) for details.
If your plugin is hosted on GitHub, it is also readily made available via these GitHub Actions:
- [IntelliJ Platform Plugin Verifier](https://github.com/marketplace/actions/intellij-platform-plugin-verifier)
- [IntelliJ Plugin Verifier](https://github.com/marketplace/actions/intellij-plugin-verifier)
### IDE Support
Consider using the following IDE inspections to get additional alerts about code that uses unstable API features: 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 API Usage
- JVM languages \| Unstable type is used in signature - 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. The following pages list the breaking changes in IDE/plugin releases with required/recommended steps to take by plugin authors.
* [**Changes in 2020.***](api_changes/api_changes_list_2020.md) * [**Changes in 2020.***](api_changes/api_changes_list_2020.md)