From babc57127451d365ac017a78a6094ae12eeab7f2 Mon Sep 17 00:00:00 2001
From: Huiwen <mhqnwt@gmail.com>
Date: Wed, 23 Oct 2024 08:52:00 +0000
Subject: [PATCH] [gha] update gateway EAP plugin to use `build` instead of
 `version`

---
 .../lib/jb-helper/jb-gradle-task-config.ts            | 11 +++++++----
 .../ide/gha-update-image/lib/jb-helper/jb-helper.ts   |  6 ++++++
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/components/ide/gha-update-image/lib/jb-helper/jb-gradle-task-config.ts b/components/ide/gha-update-image/lib/jb-helper/jb-gradle-task-config.ts
index 1e21bbfe46d2b8..8819213c212f0c 100644
--- a/components/ide/gha-update-image/lib/jb-helper/jb-gradle-task-config.ts
+++ b/components/ide/gha-update-image/lib/jb-helper/jb-gradle-task-config.ts
@@ -5,6 +5,9 @@ import { parseArgs } from "util";
 
 export type TaskInfo = TargetInfo & { id: number; taskName: string };
 
+// Official doc https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html#target-versions-installers:~:text=The%20listing%20of%20all%20present%20installers%20can%20be%20resolved%20with%20updates%20XML%20files%20for%20JetBrains%20IDEs%20and%20Android%20Studio%20as%20well%20as%20by%20executing%20the%20printProductsReleases%20task.
+// But use https://data.services.jetbrains.com/products/releases?code=GW&type=eap,rc,release&platform=linux seems better
+
 export const latestBackendPluginGradleTarget: TaskInfo = {
     id: 1,
     taskName: "Latest Backend Plugin",
@@ -24,7 +27,7 @@ pluginUntilBuild={{pluginUntilBuild}}
 # Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl
 # See https://jb.gg/intellij-platform-builds-list for available build versions.
 pluginVerifierIdeVersions={{pluginVerifierIdeVersions}}
-# Version from "com.jetbrains.intellij.idea" which can be found at https://www.jetbrains.com/intellij-repository/snapshots
+# Version from "com.jetbrains.intellij.idea" which can be found at https://www.jetbrains.com/updates/updates.xml or exec \`./gradlew printProductsReleases\`
 platformVersion={{platformVersion}}
 `,
 };
@@ -35,7 +38,7 @@ export const latestGatewayPluginGradleTarget: TaskInfo = {
     productId: "gateway",
     productCode: "GW",
     productType: "eap,rc,release",
-    usePlatformVersionType: "version",
+    usePlatformVersionType: "build",
     gradlePropertiesPath: path.resolve(
         pathToProjectRoot,
         "components/ide/jetbrains/gateway-plugin/gradle-latest.properties",
@@ -48,7 +51,7 @@ pluginUntilBuild={{pluginUntilBuild}}
 # Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl
 # See https://jb.gg/intellij-platform-builds-list for available build versions.
 pluginVerifierIdeVersions={{pluginVerifierIdeVersions}}
-# Version from "com.jetbrains.gateway" which can be found at https://www.jetbrains.com/intellij-repository/snapshots
+# Version from "com.jetbrains.gateway" which can be found at https://www.jetbrains.com/updates/updates.xml or exec \`./gradlew printProductsReleases\`
 platformVersion={{platformVersion}}
 `,
 };
@@ -72,7 +75,7 @@ pluginUntilBuild={{pluginUntilBuild}}
 # Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl
 # See https://jb.gg/intellij-platform-builds-list for available build versions.
 pluginVerifierIdeVersions={{pluginVerifierIdeVersions}}
-# Version from "com.jetbrains.gateway" which can be found at https://www.jetbrains.com/updates/updates.xml
+# Version from "com.jetbrains.gateway" which can be found at https://www.jetbrains.com/updates/updates.xml or exec \`./gradlew printProductsReleases\`
 platformVersion={{platformVersion}}
 `,
 };
diff --git a/components/ide/gha-update-image/lib/jb-helper/jb-helper.ts b/components/ide/gha-update-image/lib/jb-helper/jb-helper.ts
index c423d60a84810a..ca06aacfe31ba9 100644
--- a/components/ide/gha-update-image/lib/jb-helper/jb-helper.ts
+++ b/components/ide/gha-update-image/lib/jb-helper/jb-helper.ts
@@ -35,6 +35,12 @@ export interface TargetInfo {
      * @example eap,rc,release
      */
     productType: string;
+    /**
+     * Examples value for different type:
+     * - build 243.18137.22
+     * - version 2024.3
+     * - build-snapshot 243.18137-EAP-CANDIDATE-SNAPSHOT
+     */
     usePlatformVersionType: "build" | "version" | "build-snapshot";
     gradlePropertiesPath: string;
     gradlePropertiesTemplate: string;