Warn when the until-build property is specified for IntelliJ Platfo…

…rm version `243+` as it is ignored and set it to `null`
JetBrains · Feb 13, 2025 · 529c51f · 529c51f
1 parent 5d092f9
commit 529c51f
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - Add `ide(type: Provider<*>, version: Provider<String>, useInstaller: Provider<Boolean>)` overload to the `pluginVerification.ides` block.
 - Warn that since the IntelliJ Platform version `2025.1` (build `251`), the required Kotlin version is `2.0.0` or higher.
 - Load the `com.intellij` bundled module by default for all IntelliJ Platform types
+- Warn when the "until-build" property is specified for IntelliJ Platform version 243 or higher, as it is ignored
 
 ### Fixed
 

diff --git a/...ionTest/kotlin/org/jetbrains/intellij/platform/gradle/PluginXmlPatchingIntegrationTest.kt b/...ionTest/kotlin/org/jetbrains/intellij/platform/gradle/PluginXmlPatchingIntegrationTest.kt
@@ -10,9 +10,17 @@ class PluginXmlPatchingIntegrationTest : IntelliJPlatformIntegrationTestBase(
     resourceName = "plugin-xml-patching",
 ) {
 
+    override val defaultProjectProperties
+        get() = super.defaultProjectProperties + mapOf(
+            "languageVersion" to "17",
+            "sinceBuild" to "231",
+        )
+
     @Test
     fun `patch plugin_xml`() {
-        build(Tasks.BUILD_PLUGIN, projectProperties = defaultProjectProperties) {
+        build(Tasks.BUILD_PLUGIN, projectProperties = defaultProjectProperties + mapOf(
+            "untilBuild" to "233.*"
+        )) {
             assertTaskOutcome(Tasks.PATCH_PLUGIN_XML, TaskOutcome.SUCCESS)
 
             val patchedPluginXml = buildDirectory.resolve("tmp/patchPluginXml/plugin.xml")
@@ -29,4 +37,23 @@ class PluginXmlPatchingIntegrationTest : IntelliJPlatformIntegrationTestBase(
                     """.trimIndent()
         }
     }
+
+    @Test
+    fun `patch plugin_xml and set the until-build to null if targeted 243+`() {
+        build(Tasks.BUILD_PLUGIN, projectProperties = defaultProjectProperties + mapOf(
+            "intellijPlatform.version" to "2024.3",
+            "languageVersion" to "21",
+            "sinceBuild" to "243",
+        )) {
+            assertTaskOutcome(Tasks.PATCH_PLUGIN_XML, TaskOutcome.SUCCESS)
+
+            val patchedPluginXml = buildDirectory.resolve("tmp/patchPluginXml/plugin.xml")
+            assertExists(patchedPluginXml)
+
+            patchedPluginXml containsText //language=xml
+                    """
+                    <idea-version since-build="243" />
+                    """.trimIndent()
+        }
+    }
 }
diff --git a/src/integrationTest/resources/plugin-xml-patching/build.gradle.kts b/src/integrationTest/resources/plugin-xml-patching/build.gradle.kts
@@ -1,5 +1,8 @@
 val intellijPlatformTypeProperty = providers.gradleProperty("intellijPlatform.type")
 val intellijPlatformVersionProperty = providers.gradleProperty("intellijPlatform.version")
+val languageVersionProperty = providers.gradleProperty("languageVersion").map { it.toInt() }
+val sinceBuildProperty = providers.gradleProperty("sinceBuild")
+val untilBuildProperty = providers.gradleProperty("untilBuild")
 
 plugins {
     id("org.jetbrains.kotlin.jvm")
@@ -9,7 +12,7 @@ plugins {
 version = "1.0.0"
 
 kotlin {
-    jvmToolchain(17)
+    jvmToolchain(languageVersionProperty.get())
 }
 
 repositories {
@@ -23,7 +26,6 @@ repositories {
 dependencies {
     intellijPlatform {
         create(intellijPlatformTypeProperty, intellijPlatformVersionProperty)
-        instrumentationTools()
     }
 }
 
@@ -33,8 +35,8 @@ intellijPlatform {
 
     pluginConfiguration {
         ideaVersion {
-            sinceBuild = "231"
-            untilBuild = "233.*"
+            sinceBuild = sinceBuildProperty
+            untilBuild = untilBuildProperty
         }
     }
 }
diff --git a/...ain/kotlin/org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformExtension.kt b/...ain/kotlin/org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformExtension.kt
@@ -29,7 +29,10 @@ import org.jetbrains.intellij.platform.gradle.models.ProductRelease.Channel
 import org.jetbrains.intellij.platform.gradle.models.productInfo
 import org.jetbrains.intellij.platform.gradle.plugins.configureExtension
 import org.jetbrains.intellij.platform.gradle.providers.ProductReleasesValueSource.FilterParameters
-import org.jetbrains.intellij.platform.gradle.tasks.*
+import org.jetbrains.intellij.platform.gradle.tasks.BuildSearchableOptionsTask
+import org.jetbrains.intellij.platform.gradle.tasks.PatchPluginXmlTask
+import org.jetbrains.intellij.platform.gradle.tasks.PublishPluginTask
+import org.jetbrains.intellij.platform.gradle.tasks.SignPluginTask
 import org.jetbrains.intellij.platform.gradle.tasks.VerifyPluginTask.*
 import org.jetbrains.intellij.platform.gradle.tasks.aware.PluginVerifierAware
 import org.jetbrains.intellij.platform.gradle.tasks.aware.SigningAware
@@ -454,7 +457,13 @@ abstract class IntelliJPlatformExtension @Inject constructor(
                             it.runCatching { productInfo.buildNumber.toVersion() }.getOrDefault(Version())
                         }
                         sinceBuild.convention(buildVersion.map { "${it.major}.${it.minor}" })
-                        untilBuild.convention(buildVersion.map { "${it.major}.*" })
+                        untilBuild.convention(buildVersion.flatMap { version ->
+                            if (version.major >= 243) {
+                                project.provider { null }
+                            } else {
+                                project.provider { "${version.major}.*" }
+                            }
+                        })
                     }
             }
         }

diff --git a/...tlin/org/jetbrains/intellij/platform/gradle/tasks/VerifyPluginProjectConfigurationTask.kt b/...tlin/org/jetbrains/intellij/platform/gradle/tasks/VerifyPluginProjectConfigurationTask.kt
@@ -133,6 +133,9 @@ abstract class VerifyPluginProjectConfigurationTask : DefaultTask(), IntelliJPla
                         if (sinceBuild.major < platformBuild.major) {
                             yield("The since-build='$sinceBuild' is lower than the target IntelliJ Platform major version: '${platformBuild.major}'.")
                         }
+                        if (sinceBuild.major >= 243 && file.parse { ideaVersion.untilBuild != null }) {
+                            yield("The until-build property is ignored for IntelliJ Platform version 243 or higher.")
+                        }
                         if (sinceBuildJavaVersion < targetCompatibilityJavaVersion) {
                             yield("The Java configuration specifies targetCompatibility=$targetCompatibilityJavaVersion but since-build='$sinceBuild' property requires targetCompatibility='$sinceBuildJavaVersion'.")
                         }

diff --git a/.../org/jetbrains/intellij/platform/gradle/tasks/VerifyPluginProjectConfigurationTaskTest.kt b/.../org/jetbrains/intellij/platform/gradle/tasks/VerifyPluginProjectConfigurationTaskTest.kt
@@ -328,6 +328,38 @@ class VerifyPluginProjectConfigurationTaskTest : IntelliJPluginTestBase() {
         }
     }
 
+    @Test
+    fun `report ignored until-build for version 243 or higher`() {
+        buildFile write //language=kotlin
+                """
+                intellijPlatform {
+                    pluginConfiguration {
+                        ideaVersion {
+                            sinceBuild = "243"
+                            untilBuild = "243.*"
+                        }
+                    }
+                }
+                """.trimIndent()
+
+        pluginXml write //language=xml
+                """
+                <idea-plugin>
+                    <name>PluginName</name>
+                    <description>Lorem ipsum.</description>
+                    <vendor>JetBrains</vendor>
+                    <idea-version since-build="243" until-build="243.*" />
+                </idea-plugin>
+                """.trimIndent()
+
+        build(Tasks.VERIFY_PLUGIN_PROJECT_CONFIGURATION) {
+            assertContains(HEADER, output)
+            assertContains(
+                "- The until-build property is ignored for IntelliJ Platform version 243 or higher.", output
+            )
+        }
+    }
+
     @Test
     fun `report invalid sinceBuild if contains wildcard`() {
         buildFile write //language=kotlin