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

extract plugin_compatibility.md topic, take #3

Browse Source
This commit is contained in:
Yann Cébron 2022-07-14 15:59:27 +02:00
parent 8c6660e992
commit 762eed2536
12 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
reference_guide/api_changes_list_2019.md
View File

@ -59,7 +59,7 @@ NOTE: You are allowed to prettify the pattern using links: [`org.example.Foo`](h
NOTE: Entries not starting with code quotes (`name`) can be added to document non-code changes and will be skipped in API verification.
-->
Please see [Incompatible API Changes](api_changes_list.md) on how to verify compatibility.
Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems.
> Changes from API marked with `@Deprecated(forRemoval=true)` or any of [`org.jetbrains.annotations.ApiStatus`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java) `@Experimental`, `@ScheduledForRemoval`, or `@Internal` are not listed here, as incompatible changes are to be expected.
>

2
reference_guide/api_changes_list_2020.md
View File

@ -60,7 +60,7 @@ NOTE: You are allowed to prettify the pattern using links: [`org.example.Foo`](h
NOTE: Entries not starting with code quotes (`name`) can be added to document non-code changes and will be skipped in API verification.
-->
Please see [Incompatible API Changes](api_changes_list.md) on how to verify compatibility.
Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems.
> Changes from API marked with `@Deprecated(forRemoval=true)` or any of [`org.jetbrains.annotations.ApiStatus`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java) `@Experimental`, `@ScheduledForRemoval`, or `@Internal` are not listed here, as incompatible changes are to be expected.
>

2
reference_guide/api_changes_list_2021.md
View File

@ -60,7 +60,7 @@ NOTE: You are allowed to prettify the pattern using links: [`org.example.Foo`](h
NOTE: Entries not starting with code quotes (`name`) can be added to document non-code changes and will be skipped in API verification.
-->
Please see [Incompatible API Changes](api_changes_list.md) on how to verify compatibility.
Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems.
> Changes from API marked with `@Deprecated(forRemoval=true)` or any of [`org.jetbrains.annotations.ApiStatus`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java) `@Experimental`, `@ScheduledForRemoval`, or `@Internal` are not listed here, as incompatible changes are to be expected.
>

2
reference_guide/api_changes_list_2022.md
View File

@ -60,7 +60,7 @@ NOTE: You are allowed to prettify the pattern using links: [`org.example.Foo`](h
NOTE: Entries not starting with code quotes (`name`) can be added to document non-code changes and will be skipped in API verification.
-->
Please see [Incompatible API Changes](api_changes_list.md) on how to verify compatibility.
Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems.
> Changes from API marked with `@Deprecated(forRemoval=true)` or any of [`org.jetbrains.annotations.ApiStatus`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java) `@Experimental`, `@ScheduledForRemoval`, or `@Internal` are not listed here, as incompatible changes are to be expected.
>

2
topics/appendix/api_internal/api_internal.md
View File

@ -12,7 +12,7 @@ This page lists commonly used API annotated with [`org.jetbrains.annotations.Api
> usages in other packages of the declaring library, but it **must not be used outside of that library**. Such elements
> may be renamed, changed or removed in future versions.
Such violations are reported from [Plugin Verifier](api_changes_list.md#plugin-verifier) and are highlighted in the IDE using [dedicated inspection](api_changes_list.md#ide-support).
Such violations are reported from [Plugin Verifier](verifying_plugin_compatibility.md#plugin-verifier) and are highlighted in the IDE using [dedicated inspection](verifying_plugin_compatibility.md#ide-support).
Each entry is mapped to its corresponding _Replacement_, pointing to recommended API.

2
topics/appendix/resources/useful_links.md
View File

@ -15,7 +15,7 @@ The following links represent useful resources for working with the IntelliJ Pla
* [IDE Settings, Caches, Logs, and Plugins](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs)
* [Internal Actions Menu](internal_actions_intro.md)
* [IntelliJ Platform Artifacts Repository](intellij_artifacts.md)
* [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) (see also [Verifying Compatibility](api_changes_list.md#verifying-compatibility))
* [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) (see also [](verifying_plugin_compatibility.md))
* [IntelliJ Platform Explorer](https://jb.gg/ipe) ([Blog post](https://blog.jetbrains.com/platform/2020/12/intellij-platform-explorer-get-to-the-extension-point/))
* [IntelliJ Log Analyzer](https://github.com/annikovk/IntelliJ-Log-Analyzer)
* [Figma UI Kit](https://jetbrains.design/intellij/resources/UI_kit/) ([Blog post](https://blog.jetbrains.com/idea/2021/05/intellij-platform-ui-kit/))

2
topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md
View File

@ -1145,7 +1145,7 @@ Acceptable values
## runPluginVerifier Task
Runs the [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) tool to check the binary compatibility with specified [IDE builds](api_changes_list.md).
Runs the [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) tool to check the binary compatibility with specified IDE builds (see also [](verifying_plugin_compatibility.md)).
Plugin Verifier DSL `runPluginVerifier { ... }` allows to define the list of IDEs used for the verification, as well as explicit tool version and any of the available [options](https://github.com/JetBrains/intellij-plugin-verifier#common-options) by proxifying them to the Verifier CLI.

2
topics/basics/getting_started/build_number_ranges.md
View File

@ -5,7 +5,7 @@ Use this reference of build number ranges to specify the correct `since-build` a
Setting the actual values in <path>plugin.xml</path> is usually managed by [`patchPluginXml`](tools_gradle_intellij_plugin.md#patchpluginxml-task) Gradle task, see [Patching the Plugin Configuration File](gradle_guide.md#patching-the-plugin-configuration-file) for details.
> Compatibility with the specified version range (and compatible products) must always be verified using [Plugin Verifier](api_changes_list.md#verifying-compatibility) to ensure binary compatibility.
> Compatibility with the specified version range (and compatible products) must always be verified using [](verifying_plugin_compatibility.md#plugin-verifier) to ensure binary compatibility.
>
> Plugins hosted on [JetBrains Marketplace](https://plugins.jetbrains.com) are checked automatically.
> According to [Approval Guidelines](https://plugins.jetbrains.com/legal/approval-guidelines), incompatible plugin versions will be restricted by JetBrains if necessary.

2
topics/basics/getting_started/plugin_compatibility.md
View File

@ -271,7 +271,7 @@ Continuing the example, search the PHP plugin's <path>plugin.xml</path> file for
Before marking a plugin project as _dependent only on modules in a target product_ in addition to `com.intellij.modules.platform`, verify the plugin isn't implicitly dependent on any APIs that are specific to IntelliJ IDEA.
For [Gradle-based](gradle_build_system.md) projects, [Plugin Verifier](api_changes_list.md#plugin-verifier) can be used to ensure compatibility with all specified target IDEs.
For [Gradle-based](gradle_build_system.md) projects, [](verifying_plugin_compatibility.md#plugin-verifier) can be used to ensure compatibility with all specified target IDEs.
For [DevKit-based](using_dev_kit.md) projects, create an SDK pointing to an installation of the intended target IntelliJ Platform-based product, e.g., PhpStorm, rather than IntelliJ IDEA.
Use the same development version of the IntelliJ platform as the targeted product.

2
topics/basics/plugin_structure/dynamic_plugins.md
View File

@ -19,7 +19,7 @@ For a plugin to support this, all restrictions listed below must be met.
To verify a plugin locally, invoke <menupath>Code | Analyze Code | Run Inspection by Name...</menupath> and run <control>Plugin DevKit | Plugin descriptor | Plugin.xml dynamic plugin verification inspection</control> inspection on all plugin descriptor files.
For plugins hosted on the [JetBrains Marketplace](https://plugins.jetbrains.com) the built-in [Plugin Verifier](https://blog.jetbrains.com/platform/2018/07/plugins-repository-now-integrates-with-the-plugin-verification-tool/) will run these checks automatically.
See [Plugin Verifier](api_changes_list.md#plugin-verifier) for more information on how to run it locally or on CI.
See [](verifying_plugin_compatibility.md#plugin-verifier) for more information on how to run it locally or on CI.
### No Use of Components

2
topics/intro/about.md
View File

@ -73,7 +73,7 @@ Links to [useful resources](useful_links.md), a [](glossary.md), [](extension_po
#### Appendix II — API Changes
Provides a list of [backward-incompatible](api_changes_list.md) API changes as well as [notable changes and new features](api_notable.md) in each major release of the IntelliJ Platform.
Information on [](verifying_plugin_compatibility.md) and list of [backwards-incompatible](api_changes_list.md) API changes as well as [notable changes and new features](api_notable.md) in each major release of the IntelliJ Platform.
#### Appendix III — Tools

2
topics/tutorials/build_system/gradle_guide.md
View File

@ -125,7 +125,7 @@ The Gradle plugin provides two tasks that allow for running integrity and compat
* [`runPluginVerifier`](tools_gradle_intellij_plugin.md#runpluginverifier-task) task - runs the [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) tool to check the binary compatibility with specified IntelliJ IDE builds.
Plugin Verifier integration task allows for configuring the exact IDE versions that your plugin will be checked against.
See [Verifying Compatibility](api_changes_list.md#verifying-compatibility) for more information.
See [](verifying_plugin_compatibility.md#plugin-verifier) for more information.
### Publishing with the Gradle Plugin