snippets: apiChangesHeader

This commit is contained in:
Yann Cébron 2022-12-01 11:39:16 +01:00
parent 97ec5ac3c9
commit 7a85eaab23
6 changed files with 24 additions and 46 deletions

View File

@ -1,4 +1,4 @@
[//]: # (title: Incompatible Changes in IntelliJ Platform and Plugins API 2019.*) # Incompatible Changes in IntelliJ Platform and Plugins API 2019.*
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
@ -59,13 +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. 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 [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems. <include from="snippets.md" element-id="apiChangesHeader"/>
> 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.
>
> For API annotated with `ApiStatus.@Internal`, see [](api_internal.md) for more details and replacements.
>
{style="note"}
## 2019.3 ## 2019.3

View File

@ -1,4 +1,4 @@
[//]: # (title: Incompatible Changes in IntelliJ Platform and Plugins API 2020.*) # Incompatible Changes in IntelliJ Platform and Plugins API 2020.*
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
@ -60,13 +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. 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 [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems. <include from="snippets.md" element-id="apiChangesHeader"/>
> 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.
>
> For API annotated with `ApiStatus.@Internal`, see [](api_internal.md) for more details and replacements.
>
{style="note"}
## 2020.3 ## 2020.3

View File

@ -1,4 +1,4 @@
[//]: # (title: Incompatible Changes in IntelliJ Platform and Plugins API 2021.*) # Incompatible Changes in IntelliJ Platform and Plugins API 2021.*
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
@ -60,13 +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. 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 [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems. <include from="snippets.md" element-id="apiChangesHeader"/>
> 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.
>
> For API annotated with `ApiStatus.@Internal`, see [](api_internal.md) for more details and replacements.
>
{style="note"}
> Java 11 is required ([blog post](https://blog.jetbrains.com/platform/2020/09/intellij-project-migrates-to-java-11/)) when targeting 2020.3 and later only. > Java 11 is required ([blog post](https://blog.jetbrains.com/platform/2020/09/intellij-project-migrates-to-java-11/)) when targeting 2020.3 and later only.
> >
@ -74,8 +68,6 @@ Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier a
> >
{style="note"} {style="note"}
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
## 2021.3 ## 2021.3
### IntelliJ Platform 2021.3 ### IntelliJ Platform 2021.3

View File

@ -1,4 +1,4 @@
[//]: # (title: Incompatible Changes in IntelliJ Platform and Plugins API 2022.*) # Incompatible Changes in IntelliJ Platform and Plugins API 2022.*
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
@ -60,13 +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. 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 [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems. <include from="snippets.md" element-id="apiChangesHeader"/>
> 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.
>
> For API annotated with `ApiStatus.@Internal`/`@IntellijInternalApi`, see [](api_internal.md) for more details and replacements.
>
{style="note"}
> Java 17 is required ([blog post](https://blog.jetbrains.com/platform/2022/08/intellij-project-migrates-to-java-17/) when targeting 2022.2 or later only. > Java 17 is required ([blog post](https://blog.jetbrains.com/platform/2022/08/intellij-project-migrates-to-java-17/) when targeting 2022.2 or later only.
> >
@ -76,8 +70,6 @@ Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier a
> >
{style="note"} {style="note"}
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
## 2022.3 ## 2022.3
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include> <include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>

View File

@ -1,4 +1,4 @@
[//]: # (title: Incompatible Changes in IntelliJ Platform and Plugins API 2023.*) # Incompatible Changes in IntelliJ Platform and Plugins API 2023.*
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
@ -60,13 +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. 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 [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems. <include from="snippets.md" element-id="apiChangesHeader"/>
> 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.
>
> For API annotated with `ApiStatus.@Internal`/`@IntellijInternalApi`, see [](api_internal.md) for more details and replacements.
>
{style="note"}
> Java 17 is required ([blog post](https://blog.jetbrains.com/platform/2022/08/intellij-project-migrates-to-java-17/) when targeting 2022.2 or later only. > Java 17 is required ([blog post](https://blog.jetbrains.com/platform/2022/08/intellij-project-migrates-to-java-17/) when targeting 2022.2 or later only.
> >
@ -76,8 +70,6 @@ Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier a
> >
{style="note"} {style="note"}
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include> <include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>
## 2023.1 ## 2023.1

View File

@ -25,3 +25,17 @@
> Qualifying Open Source projects can [apply for free licenses](https://www.jetbrains.com/community/opensource/) of JetBrains products. > Qualifying Open Source projects can [apply for free licenses](https://www.jetbrains.com/community/opensource/) of JetBrains products.
</snippet> </snippet>
<snippet id="apiChangesHeader">
Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier and IDE inspections to check such problems.
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
> 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.
>
> For API annotated with `ApiStatus.@Internal`/`@IntellijInternalApi`, see [](api_internal.md) for more details and replacements.
>
{style="note"}
</snippet>