#911 support intellij 2024.2 by updating gradle version #1053

staicy123 · 2024-10-28T06:58:12Z

Fixes #911
Updated intellij platform and kotlin jvm version
Updated source compatability and target compatability in build.gradle and given java version inside gradle.properties file
Changed intellij to intellijPlatform and added it inside dependencies tag
Updated runIde task in build.gradle
Added intellijPlatform tag to add buildSearchableOptions, since build, until build and add the changeNotes
updated platformVersion in gradle.properties

vaisakhkannan · 2024-11-08T11:55:34Z

NOTE : This PR doesn’t include the changes for the runIdeForUiTests task. That's why this PR build is failed. I will open a separate PR for the runIdeForUiTests task to enable UI tests(since I worked mainly on Ui test task issue #885), which will ensure both UI and unit tests pass in that build. I have tested this in my fork branch with these PR changes and the runIdeForUiTests task enabled, and the build succeeded for IntelliJ IDE version 2024.1. However, if we update to version 2024.2(in gradle.properties), we will encounter both unit and UI test failures. So, we'll just stick with IntelliJ IDEA version 2024.1 for now.

Check the build that enabled runIdeForUiTests Task : https://github.com/vaisakhkannan/liberty-tools-intellij/actions/runs/11741958620
Branch : https://github.com/vaisakhkannan/liberty-tools-intellij/tree/refs/heads/%23885-Enable-runIdeForUiTests-task
( This branch includes Stacy's this PR change )

cc: @TrevCraw

gradle.properties

build.gradle

TrevCraw

The commit history associated with this PR is confusing. There are some duplicate commits that have the exact same changes:

There are also commits that have the same description, but have different changes:

Please take some time to clean up the commit history.

TrevCraw · 2024-11-09T01:17:51Z

build.gradle

-patchPluginXml {
-    changeNotes = """
-        <h2> 24.0.9 </h2>
+intellijPlatform {


why is intellijPlatform in three different spots?

Here in this doc it's explained https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin.html#setting-up-intellij-platform to add intellijPlatform in different places as per new updation.

TrevCraw · 2024-11-09T01:20:13Z

build.gradle

+            sinceBuild = providers.gradleProperty("pluginSinceBuild")
+            untilBuild = providers.gradleProperty("pluginUntilBuild")
+        }
+        changeNotes = """


why did the change notes need to be moved from pathPluginXml to intellijPlatform?

This change was suggested by jetbrains team to move the patchPluginXml.changeNotes to intellijPlatform.pluginConfiguration.changeNotes
https://jetbrains-platform.slack.com/archives/C5U8BM1MK/p1729610706101729?thread_ts=1729576853.003949&cid=C5U8BM1MK

OK. We will need to confirm that this still works correctly when the plugin is uploaded to the marketplace. Can you please open an issue to upload an early version of the plugin to a private repo/stream in the JetBrains marketplace to check that the plugin info and change notes are displayed properly?

Sure, I have created the issue for analysing this part here : #1112

gradle.properties

TrevCraw · 2024-11-09T01:30:13Z

build.gradle

@@ -97,9 +103,7 @@ dependencies {
    testImplementation 'com.intellij.remoterobot:remote-robot:' + remoteRobotVersion
    testImplementation 'com.intellij.remoterobot:remote-fixtures:' + remoteRobotVersion
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.2'
-    testImplementation('com.jetbrains.intellij.maven:maven-test-framework:241.15989.150') {


why is this being removed? This will eventually be updated later, but should be left alone for now.

Removed this dependency as jetbrains have introduced new TEST Framework which will automatically include this dependency based on intellij version in our project. This was suggested by jetbrains team here
https://jetbrains-platform.slack.com/archives/C5U8BM1MK/p1730297530842639?thread_ts=1730105939.390899&cid=C5U8BM1MK

So we have confirmed that we can run the unit tests with this dependency removed?

Yes, @TrevCraw,

Instead of adding maven-test-framework directly, IntelliJ 2024.2 introduced a way to add this line: testFramework TestFrameworkType.Plugin.Maven.INSTANCE within the intellijPlatform setup under the dependencies tag. This approach ensures that the dependency is downloaded in our project, and the version is determined by the IntelliJ platform version specified.

However, even with this adjustment, unit tests do not work in IntelliJ 2024.2. That said, making this change has been verified to fully support unit tests in IntelliJ 2024.1.

These are the dependencies used in the project, and when removing the direct dependency and instead adding the framework as suggested by JetBrains, maven-test-framework is downloaded correctly.

Thanks,

TrevCraw · 2024-11-09T01:33:51Z

build.gradle

-    version.set(remoteRobotVersion)
-}
-
-runIdeForUiTests {


Similar to the unit test framework, we should not be removing the runIdeForUiTests or downloadRobotServerPlugin sections. This should be left alone for now.

I removed this part, as @vaisakhkannan will be raising the PR for UI test part including all this. If you think I shouldn't remove and comment it out I can do so.

Please do not remove. Let @vaisakhkannan handle it in his PR.

Sure, I will add back the changes.

gradle.properties

TrevCraw · 2024-11-09T01:42:50Z

build.gradle

+        pluginVerifier()
+        zipSigner()
+        instrumentationTools()


Could you explain why these lines needed to be added?

InstrumentationTools()
When we remove this it will throw error during buildPlugin:

=> The code instrumentation process handled with the instrumentCode task, requires extra dependencies to work and properly adjust the Java bytecode. There's the instrumentationTools() dependencies helper introduced to apply all required dependencies using default configuration
https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html#java-runtime
PluginVerifier():
the Plugin Verifier is a tool used to check whether your IntelliJ IDEA plugin is compatible with specific versions of IntelliJ IDEA (or other JetBrains IDEs like PyCharm, WebStorm, etc.). It helps you ensure that your plugin works correctly with different versions of the IDE before releasing it to users, especially when updates to the IDE or your plugin occur.

Why Do You Need It?

When you develop a plugin for an IntelliJ-based IDE, new versions of the IDE might introduce changes that could potentially break the functionality of your plugin. The Plugin Verifier ensures your plugin works with the version(s) of the IDE you intend it to support. It checks for compatibility issues and reports any problems, such as deprecated API usage, missing features, or unsupported changes in the IDE.

Without verifying, your plugin might break when users upgrade to newer versions of the IDE, leading to crashes or broken functionality for them.https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html#target-platforms

I am not sure whether we need zipSigner().
Purpose: Plugin Signing is a security feature introduced by JetBrains starting from 2021.2 to protect users from potentially malicious or tampered plugins in the JetBrains Marketplace (and in IntelliJ-based IDEs like IntelliJ IDEA, PyCharm, WebStorm, etc.).

In simple terms, Plugin Signing ensures that the plugin you install on your IDE has not been tampered with and comes from the original developer who created it.
https://plugins.jetbrains.com/docs/intellij/plugin-signing.html

build.gradle

Updated intellij platform and kotlin jvm version

Updated source compatability and target compatability in build.gradle and given java version inside gradle.properties file

…ij version and platform Changed intellij to intellijPlatform and added it inside dependencies tag

Updated runIde task in build.gradle

…ld, until build and add the changeNotes Added intellijPlatform tag to add buildSearchableOptions, since build, until build and add the changeNotes

Changed intellij to intellijPlatform and added it inside dependencies tag

updated platformVersion

Removed manual dependency added for maven test as jetbrains providing a testframework which will auto download latest maven test version

…dependency=false defaulted intellij version to 2024.1 i.e PROD version and added kotlin.stdlib.default.dependency=false to stop including this lib automatically when build is ran

Added an import and commented runIdeForUiTest task as it doesn't support intellij 2024.2 version

Removed since and until build from plugin.xml since already given in gradle.properties

…g for 2024.1 version

…n running UI test

staicy123 requested a review from TrevCraw October 28, 2024 06:58

staicy123 mentioned this pull request Oct 28, 2024

IntelliJ 2024.2: Migrate to IntelliJ Platform Gradle Plugin 2.x #911

Open

aparnamichael requested review from vaisakhkannan and dessina-devasia November 1, 2024 06:31

staicy123 force-pushed the #911-Support-Intellij-2024.2-by-updating-gradle-version branch from 8fb3a84 to 5074130 Compare November 8, 2024 09:53

staicy123 mentioned this pull request Nov 8, 2024

Configure UI tests to run with Java 21 and 2024.2 #1088

Open

vaisakhkannan requested changes Nov 8, 2024

View reviewed changes

gradle.properties Outdated Show resolved Hide resolved

dessina-devasia previously approved these changes Nov 8, 2024

View reviewed changes

build.gradle Outdated Show resolved Hide resolved

TrevCraw reviewed Nov 9, 2024

View reviewed changes

TrevCraw requested changes Nov 9, 2024

View reviewed changes

staicy123 dismissed dessina-devasia’s stale review via b597088 November 11, 2024 11:57

staicy123 force-pushed the #911-Support-Intellij-2024.2-by-updating-gradle-version branch from 39fa3f5 to 9a868b2 Compare November 11, 2024 12:50

staicy123 added 15 commits November 11, 2024 18:43

Updated intellij platform 2.1.0 and kotlin jvm version 1.9.24

483b5d9

Updated intellij platform and kotlin jvm version

Updated build.gradle and added gradle.properties file

19c8088

Updated source compatability and target compatability in build.gradle and given java version inside gradle.properties file

Added intellijPlatform, since and until build, bundled plugin, intell…

d0a87d9

…ij version and platform Changed intellij to intellijPlatform and added it inside dependencies tag

Updated runIde task in build.gradle

3ad17db

Updated runIde task in build.gradle

Updated intellijPlatform tag to add buildSearchableOptions, since bui…

111d7a4

…ld, until build and add the changeNotes Added intellijPlatform tag to add buildSearchableOptions, since build, until build and add the changeNotes

Updated kotlin version to 2.0.20

e518ace

Changed intellij to intellijPlatform and added it inside dependencies tag

updated platformVersion

7385bb6

updated platformVersion

Updated remote robot version

843b27a

Removed manual dependency added for maven test

ea0cbf0

Removed manual dependency added for maven test as jetbrains providing a testframework which will auto download latest maven test version

defaulted intellij version to 2024.1 and added kotlin.stdlib.default.…

717e0e1

…dependency=false defaulted intellij version to 2024.1 i.e PROD version and added kotlin.stdlib.default.dependency=false to stop including this lib automatically when build is ran

Added an import and commented runIdeForUiTest task

8f91cb6

Added an import and commented runIdeForUiTest task as it doesn't support intellij 2024.2 version

Removed UI test task from build.gradle and updated few comments

3f83037

Removed since and until build from plugin.xml

8d1e9de

Removed since and until build from plugin.xml since already given in gradle.properties

Updated the intellij version in gradle.properties to latest supportin…

58c7ff6

…g for 2024.1 version

Update pluginSinceBuild version from 241.14494.240 to 241

39b2e89

staicy123 force-pushed the #911-Support-Intellij-2024.2-by-updating-gradle-version branch from 9a868b2 to 39b2e89 Compare November 11, 2024 13:20

staicy123 requested a review from TrevCraw November 11, 2024 13:40

staicy123 requested a review from dessina-devasia November 14, 2024 05:54

staicy123 added 2 commits November 14, 2024 11:27

Removed kotlin.stdlib.default.dependency as that will be required whe…

b1cb75c

…n running UI test

Added back runIdeForUiTests task

f595ab6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#911 support intellij 2024.2 by updating gradle version #1053

#911 support intellij 2024.2 by updating gradle version #1053

staicy123 commented Oct 28, 2024 •

edited

Loading

vaisakhkannan commented Nov 8, 2024 •

edited

Loading

TrevCraw left a comment

TrevCraw Nov 9, 2024

staicy123 Nov 11, 2024

TrevCraw Nov 9, 2024

staicy123 Nov 11, 2024

TrevCraw Nov 14, 2024 •

edited

Loading

staicy123 Nov 15, 2024

TrevCraw Nov 9, 2024

staicy123 Nov 11, 2024

TrevCraw Nov 14, 2024

staicy123 Nov 15, 2024

TrevCraw Nov 9, 2024

staicy123 Nov 11, 2024

TrevCraw Nov 14, 2024

staicy123 Nov 15, 2024

TrevCraw Nov 9, 2024

staicy123 Nov 11, 2024 •

edited

Loading

#911 support intellij 2024.2 by updating gradle version #1053

Are you sure you want to change the base?

#911 support intellij 2024.2 by updating gradle version #1053

Conversation

staicy123 commented Oct 28, 2024 • edited Loading

vaisakhkannan commented Nov 8, 2024 • edited Loading

TrevCraw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TrevCraw Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

staicy123 Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

staicy123 commented Oct 28, 2024 •

edited

Loading

vaisakhkannan commented Nov 8, 2024 •

edited

Loading

TrevCraw Nov 14, 2024 •

edited

Loading

staicy123 Nov 11, 2024 •

edited

Loading