plugin description

Signed-off-by: shalom <[email protected]>

Author: shalom938

README.md

@@ -1,9 +1,20 @@
 # digma-jetbrains-plugin
 
-TBD
+<!-- Plugin description -->
+**Digma is a Continuous Feedback platform. It integrates with your observability
+backend to provide meaningful code insights in the IDE. While coding,
+you can be aware of how the code behaves in runtime in various staging and production environments**
 
+### Digma provides integrated insights multiple code behavior topics including:
+
+- Error hotspots
+- Usage bottlenecks and concurrency
+- Performance trends
+
+<!-- Plugin description end -->
 
 ## Build
+
 The project must be built with jdk 11 or later as the gradle jdk.</br>
 
 ./gradlew buildPlugin -Porg.gradle.java.home=<PATH TO JDK 11></br>

build.gradle.kts

@@ -1,4 +1,5 @@
 import common.properties
+import org.jetbrains.changelog.markdownToHTML
 
 fun properties(key: String) = properties(key,project)
 
@@ -92,17 +93,17 @@ tasks {
         untilBuild.set(properties("pluginUntilBuild"))
 
         // Extract the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
-//        pluginDescription.set(
-//            projectDir.resolve("README.md").readText().lines().run {
-//                val start = "<!-- Plugin description -->"
-//                val end = "<!-- Plugin description end -->"
-//
-//                if (!containsAll(listOf(start, end))) {
-//                    throw GradleException("Plugin description section not found in README.md:\n$start ... $end")
-//                }
-//                subList(indexOf(start) + 1, indexOf(end))
-//            }.joinToString("\n").run { markdownToHTML(this) }
-//        )
+        pluginDescription.set(
+                projectDir.resolve("README.md").readText().lines().run {
+                    val start = "<!-- Plugin description -->"
+                    val end = "<!-- Plugin description end -->"
+
+                    if (!containsAll(listOf(start, end))) {
+                        throw GradleException("Plugin description section not found in README.md:\n$start ... $end")
+                    }
+                    subList(indexOf(start) + 1, indexOf(end))
+                }.joinToString("\n").run { markdownToHTML(this) }
+        )
 
         // Get the latest available change notes from the changelog file
 //        changeNotes.set(provider {

src/main/resources/META-INF/plugin.xml

@@ -5,29 +5,9 @@
     <version>${project.version}</version>
     <name>Digma Continuous Feedback</name>
     <vendor>digma.ai</vendor>
-    <description><![CDATA[
-<p>Digma is a Continuous Feedback platform. It integrates with your observability
-  backend to provide meaningful code insights in the IDE. While coding,
-  you can be aware of how the code behaves in runtime in various staging and production environments
-</p>
-<br/>
-
-<p><h2><strong>Digma provides integrated insights multiple code behavior topics including:</strong></h2></p>
-
-<ul>
-    <li>
-       Error hostpots
-    </li>
-
-    <li>
-        Usage bottlenecks and concurrency
-    </li>
-
-    <li>
-       Performance trends
-    </li>
-</ul>
-    ]]></description>
+    <description>
+        Please write plugin description in README.md , see <!-- Plugin description --> section
+    </description>
     <depends>com.intellij.modules.platform</depends>
     <depends>com.intellij.modules.vcs</depends>