tools_intellij_platform_gradle_plugin_plugins.md: Cleanups

This commit is contained in:
Karol Lewandowski 2024-04-11 08:19:42 +02:00
parent 38b1f21675
commit b842dde39b

View File

@ -80,7 +80,6 @@ Included plugins:
- [](#run)
- [](#publish)
## Module
**Plugin ID: `org.jetbrains.intellij.platform.module`**
@ -149,12 +148,11 @@ Included plugins:
- [](#test)
- [](#verify)
## Settings
**Plugin ID: `org.jetbrains.intellij.platform.settings`**
If you define repositories within the <path>settings.gradle.kts</path> using the `dependencyResolutionManagement` Gradle, make sure to include the Settings plugin in your <path>settings.gradle.kts</path>.
If repositories are defined within the <path>settings.gradle.kts</path> using the `dependencyResolutionManagement` Gradle, make sure to include the Settings plugin in your <path>settings.gradle.kts</path>.
See [](tools_intellij_platform_gradle_plugin.md#configuration.dependencyResolutionManagement) for more details.
@ -218,17 +216,16 @@ dependencies {
**Plugin ID: `org.jetbrains.intellij.platform.migration`**
The Migration Plugin is designed to assist in upgrading your configuration from Gradle IntelliJ Plugin version `1.x`.
The Migration plugin is designed to assist in upgrading your configuration from Gradle IntelliJ Plugin version `1.x`.
To prevent Gradle failing due to breaking changes, the `org.jetbrains.intellij.platform.migration` plugin was introduced to fill missing gaps and provide migration hints.
See [](tools_intellij_platform_gradle_plugin_migration.md) for more details.
## Base
**Plugin ID: `org.jetbrains.intellij.platform.base`**
The base plugin sets up all the custom configurations and transformers needed to manage the IntelliJ Platform dependency, JetBrains Runtime, CLI tools, and other plugins when they're added as dependencies.
Sets up all the custom configurations and transformers needed to manage the IntelliJ Platform dependency, JetBrains Runtime, CLI tools, and other plugins when they're added as dependencies.
It also introduces the [](tools_intellij_platform_gradle_plugin_extension.md) to the <path>build.gradle.kts</path> file along with [](tools_intellij_platform_gradle_plugin_dependencies_extension.md) and [](tools_intellij_platform_gradle_plugin_repositories_extension.md) to help preconfiguring project dependencies:
@ -254,19 +251,18 @@ intellijPlatform {
}
```
Plugin also introduces a tasks listener which allows for creating custom tasks decorated with [](tools_intellij_platform_gradle_plugin_task_awares.md).
Plugin also introduces a task listener which allows for creating custom tasks decorated with [](tools_intellij_platform_gradle_plugin_task_awares.md).
Included tasks:
- [](tools_intellij_platform_gradle_plugin_tasks.md#initializeIntelliJPlatformPlugin)
- [](tools_intellij_platform_gradle_plugin_tasks.md#printBundledPlugins)
- [](tools_intellij_platform_gradle_plugin_tasks.md#printProductsReleases)
## Build
**Plugin ID: `org.jetbrains.intellij.platform.build`**
Tasks plugin registers and preconfigures tasks responsible for patching, instrumenting, and building the plugin.
Registers and preconfigures tasks responsible for patching, instrumenting, and building the plugin.
Included tasks:
- [](tools_intellij_platform_gradle_plugin_tasks.md#buildPlugin)
@ -276,18 +272,16 @@ Included tasks:
- [](tools_intellij_platform_gradle_plugin_tasks.md#patchPluginXml)
- [](tools_intellij_platform_gradle_plugin_tasks.md#prepareSandbox)
## Publish
**Plugin ID: `org.jetbrains.intellij.platform.publish`**
Tasks plugin adds tasks responsible for signing and publishing the final plugin archive to JetBrains Marketplace.
Adds tasks responsible for signing and publishing the final plugin archive to JetBrains Marketplace.
Included tasks:
- [](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin)
- [](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin)
## Run
**Plugin ID: `org.jetbrains.intellij.platform.run`**
@ -299,12 +293,12 @@ It is also possible to introduce custom tasks so you could run your plugin again
Included tasks:
- [](tools_intellij_platform_gradle_plugin_tasks.md#runIde)
## Test
**Plugin ID: `org.jetbrains.intellij.platform.test`**
Preconfigures the existing `test` task to make the plugin testing possible (unit tests, UI tests, performance tests) as well as preconfigures the customizable `TestIdeTask` class so you could register multiple `test*` task for running tests against different IDEs.
Preconfigures the existing `test` task to make the plugin testing possible (unit tests, UI tests, performance tests).
In addition, it preconfigures the customizable `TestIdeTask` class, so it is possible to register multiple `test*` tasks for running tests against different IDEs.
Included tasks:
- [](tools_intellij_platform_gradle_plugin_tasks.md#prepareTest)
@ -312,7 +306,6 @@ Included tasks:
- [](tools_intellij_platform_gradle_plugin_tasks.md#testIdePerformance)
- [](tools_intellij_platform_gradle_plugin_tasks.md#testIdeUi)
## Verify
**Plugin ID: `org.jetbrains.intellij.platform.verify`**