mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-27 16:57:49 +08:00
add Gradle 2.x intro page
This commit is contained in:
parent
fdab19cd10
commit
7ad8389e0d
2
ijs.tree
2
ijs.tree
@ -36,7 +36,9 @@
|
||||
accepts-web-file-names="github-template.html"/>
|
||||
<toc-element topic="migrating_plugin_devkit_to_gradle.md"/>
|
||||
</toc-element>
|
||||
<toc-element topic="configuring_gradle.md">
|
||||
<toc-element topic="configuring_plugin_project.md" accepts-web-file-names="gradle-guide.html"/>
|
||||
</toc-element>
|
||||
<toc-element topic="using_kotlin.md" accepts-web-file-names="kotlin.html"/>
|
||||
<toc-element topic="ide_development_instance.md" accepts-web-file-names="settings_caches_logs.html"/>
|
||||
<toc-element topic="plugin_signing.md"/>
|
||||
|
@ -1,4 +1,4 @@
|
||||
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
# Developing a Plugin
|
||||
|
||||
@ -16,7 +16,7 @@ Before starting with the actual development, make sure to understand all require
|
||||
The recommended solution for building IntelliJ Platform plugins is using [Gradle](https://www.gradle.org) with
|
||||
a dedicated Gradle plugin:
|
||||
[](tools_intellij_platform_gradle_plugin.md) or
|
||||
[](tools_gradle_intellij_plugin.md).
|
||||
[](tools_gradle_intellij_plugin.md) (obsolete).
|
||||
|
||||
<include from="snippets.topic" element-id="gradlePluginVersion"/>
|
||||
|
||||
@ -47,7 +47,8 @@ A dedicated [SBT plugin](https://github.com/JetBrains/sbt-idea-plugin) is availa
|
||||
|
||||
* [](creating_plugin_project.md)
|
||||
* [](plugin_github_template.md)
|
||||
* [](configuring_plugin_project.md)
|
||||
* [](configuring_gradle.md)
|
||||
* [](configuring_plugin_project.md) _(Obsolete)_
|
||||
* [](using_kotlin.md)
|
||||
* [](plugin_signing.md)
|
||||
* [](publishing_plugin.md)
|
||||
|
77
topics/tutorials/build_system/configuring_gradle.md
Normal file
77
topics/tutorials/build_system/configuring_gradle.md
Normal file
@ -0,0 +1,77 @@
|
||||
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
# Configuring IntelliJ Platform Gradle Plugin (2.x)
|
||||
|
||||
<web-summary>Essential configuration and tasks for IntelliJ Platform Gradle Plugin (2.x) plugin projects.</web-summary>
|
||||
<link-summary>Configuring the essential IntelliJ Platform Gradle Plugin (2.x) attributes and tasks.</link-summary>
|
||||
|
||||
This section presents a short overview of the most important Gradle plugin configuration elements to achieve commonly desired functionality.
|
||||
|
||||
For more advanced options and topics, see:
|
||||
|
||||
- [](tools_intellij_platform_gradle_plugin.md) reference
|
||||
- [](tools_intellij_platform_gradle_plugin_faq.md)
|
||||
- [](tools_intellij_platform_gradle_plugin_recipes.md)
|
||||
- [](tools_intellij_platform_gradle_plugin_migration.md)
|
||||
|
||||
|
||||
<include from="snippets.topic" element-id="gradlePluginVersion"/>
|
||||
|
||||
## Keep Up To Date
|
||||
|
||||
IntelliJ Platform Gradle Plugin (2.x) and [Gradle](https://gradle.org/install/) build system are constantly developed, and every new release
|
||||
brings important bug fixes, new features, and improvements that make the development more efficient.
|
||||
|
||||
It is strongly recommended to keep updating both Gradle and IntelliJ Platform Gradle Plugin to the latest versions.
|
||||
Newer IDE releases might not be supported fully in older releases of the IntelliJ Platform Gradle Plugin.
|
||||
|
||||
> The current IntelliJ Platform Gradle Plugin (2.x) version is **%intellij-platform-gradle-plugin-version%**
|
||||
>
|
||||
{style="note"}
|
||||
|
||||
## Setup
|
||||
|
||||
See [](tools_intellij_platform_gradle_plugin.md#configuration) for the necessary declaration of repositories.
|
||||
|
||||
## Target Platform and Dependencies
|
||||
|
||||
<include from="configuring_plugin_project.md" element-id="whichPlatformVersion"/>
|
||||
|
||||
If a matching version of the specified IntelliJ Platform is not present on the local machine, the Gradle plugin will download it.
|
||||
IntelliJ IDEA then indexes the build and any associated source code and [JetBrains Java Runtime](tools_intellij_platform_gradle_plugin_jetbrains_runtime.md).
|
||||
|
||||
To build a plugin for more than one target platform version, see [](build_number_ranges.md#multipleIDEVersions) for important notes.
|
||||
|
||||
### IntelliJ Platform Configuration
|
||||
|
||||
The target IDE platform is set in the `dependencies {}` block,
|
||||
see [](tools_intellij_platform_gradle_plugin.md#setting-up-intellij-platform) for a minimal sample.
|
||||
|
||||
[](tools_intellij_platform_gradle_plugin_dependencies_extension.md#target-platforms) lists all available extension functions for known target IDE platforms.
|
||||
|
||||
### Plugin Dependencies
|
||||
|
||||
IntelliJ Platform plugin projects may depend on either bundled or third-party plugins defined in the `dependencies {}` block,
|
||||
see [](tools_intellij_platform_gradle_plugin_dependencies_extension.md#plugins) for details.
|
||||
|
||||
The runtime dependency must be added in the [Plugin Configuration](plugin_configuration_file.md) (<path>plugin.xml</path>) file as described in
|
||||
[Plugin Dependencies](plugin_dependencies.md#dependency-declaration-in-pluginxml).
|
||||
|
||||
## Run IDE Task
|
||||
|
||||
By default, the [`runIde`](tools_intellij_platform_gradle_plugin_tasks.md#runIde) task will use the same version of the IntelliJ Platform
|
||||
for the IDE Development instance as was used for building the plugin.
|
||||
|
||||
## Verifying Plugin
|
||||
|
||||
The following tasks allow running integrity and compatibility tests:
|
||||
|
||||
- [`verifyPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin) - runs the [](verifying_plugin_compatibility.md#plugin-verifier) tool to check the binary compatibility with the specified IDE builds
|
||||
- [`verifyPluginStructure`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPluginStructure) — validates completeness and contents of [plugin.xml descriptors](plugin_configuration_file.md) as well as the plugin's archive structure
|
||||
- [`verifyPluginProjectConfiguration`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPluginProjectConfiguration) — validates the plugin project configuration
|
||||
|
||||
## Publishing Plugin
|
||||
|
||||
Review the [](publishing_plugin.md) page before using the [`publishPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin) task.
|
||||
|
||||
<include from="snippets.topic" element-id="missingContent"/>
|
@ -1,13 +1,14 @@
|
||||
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
<!-- Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
# Configuring Gradle IntelliJ Plugin
|
||||
# Configuring Gradle IntelliJ Plugin (1.x)
|
||||
<primary-label ref="Obsolete"/>
|
||||
|
||||
<link-summary>Configuring the essential Gradle IntelliJ Plugin attributes and tasks.</link-summary>
|
||||
|
||||
This section presents a guided tour of Gradle plugin attributes to achieve the commonly desired functionality.
|
||||
This page presents a guided tour of Gradle plugin attributes to achieve the commonly desired functionality.
|
||||
For more advanced options, see the full [](tools_gradle_intellij_plugin.md) reference.
|
||||
|
||||
<include from="creating_plugin_project.md" element-id="gradle1xOnly"/>
|
||||
<include from="tools_gradle_intellij_plugin.md" element-id="gradlePluginObsolete"/>
|
||||
|
||||
<include from="snippets.topic" element-id="gradlePluginVersion"/>
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user