Gradle: clarify unlimited 'untilBuild'

This commit is contained in:
Yann Cébron 2024-12-12 13:54:44 +01:00
parent 7bd6f91c5b
commit 8f3e3287ff
2 changed files with 32 additions and 7 deletions

View File

@ -646,8 +646,37 @@ The provided value is used for the `<idea-version until-build=""/>` element attr
The default value is set to the `MAJOR.*` version based on the currently selected IntelliJ Platform, such as `233.*`.
The `until-build` attribute can be unset by setting `provider { null }` as a value.
Note that passing only `null` will make Gradle use a default value instead.
The `until-build` attribute can be unset by providing `provider { null }` as a value:
<tabs group="languages">
<tab title="Kotlin" group-key="kotlin">
```kotlin
intellijPlatform {
pluginConfiguration {
ideaVersion {
untilBuild = provider { null }
}
}
}
```
</tab>
<tab title="Groovy" group-key="groovy">
```groovy
intellijPlatform {
pluginConfiguration {
ideaVersion {
untilBuild = provider { null }
}
}
}
```
</tab>
</tabs>
{style="narrow"}
Type

View File

@ -709,17 +709,13 @@ Default value
{#patchPluginXml-untilBuild}
The highest IDE version compatible with the plugin.
The `until-build` attribute can be unset by setting `provider { null }` as a value, and note that only passing `null` will make Gradle use the default value instead.
The `until-build` attribute can be unset by setting `provider { null }` as a value.
However, if `until-build` is undefined, compatibility with all the IDEs since the version specified by the `since-build` is assumed, which can cause incompatibility errors in future builds.
The provided value will be assigned to the [`<idea-version until-build="..."/>`](plugin_configuration_file.md#idea-plugin__idea-version) element attribute.
The `until-build` attribute can be unset by setting `provider { null }` as a value.
> Passing `null` will make Gradle use the default value instead.
>
{style="warning"}
{style="narrow"}
Type
: `Property<String>`