mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 18:27:49 +08:00
Notes about the IntelliJ Platform Plugin Template (#304)
This commit is contained in:
parent
33e1167402
commit
eb0a8288a0
@ -18,6 +18,7 @@
|
||||
* [Quick Start Guide](basics/basics.md)
|
||||
* [Types of Plugins](basics/types_of_plugins.md)
|
||||
* [Creating Your First Plugin](basics/getting_started.md)
|
||||
* [Using GitHub Template](tutorials/github_template.md)
|
||||
* [Using Gradle](tutorials/build_system.md)
|
||||
* [Getting Started with Gradle](tutorials/build_system/prerequisites.md)
|
||||
* [Configuring Gradle Projects](tutorials/build_system/gradle_guide.md)
|
||||
|
@ -5,8 +5,8 @@ title: Creating Your First Plugin
|
||||
|
||||
This documentation section will help you get started with developing plugins for the *IntelliJ Platform*. You can use either [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) or [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/) as your IDE (it is highly recommended to use the latest available version). Both include the complete set of plugin development tools. To become more familiar with *IntelliJ IDEA*, please refer to the [IntelliJ IDEA Web Help](https://www.jetbrains.com/idea/help/).
|
||||
|
||||
There are two supported workflows available for building plugins.
|
||||
The recommended workflow for new projects is to [use Gradle](#using-gradle).
|
||||
There are three supported workflows available for building plugins.
|
||||
The recommended workflow for new projects is to [use GitHub Template](#using-github-template) or to [use Gradle](#using-gradle) to create everything from scratch.
|
||||
The old [Plugin DevKit](#using-devkit) workflow still supports existing projects.
|
||||
|
||||
> **NOTE** If a new plugin will be Scala-based, a dedicated SBT plugin [sbt-idea-plugin](https://github.com/JetBrains/sbt-idea-plugin) is available.
|
||||
@ -24,6 +24,10 @@ Specific to development of IntelliJ Platform plugins with the Gradle plugin for
|
||||
* Gradle is fully integrated with Continuous Integration systems and [plugins.jetbrains.com](https://plugins.jetbrains.com), so it is easy to customize and extend the build and publishing processes.
|
||||
* Built-in verification task for `plugin.xml` and plugin distribution structure, the same checks as on [plugins.jetbrains.com](https://plugins.jetbrains.com).
|
||||
|
||||
## Using GitHub Template
|
||||
|
||||
* [Developing plugins using GitHub Template](/tutorials/github_template.md)
|
||||
|
||||
## Using Gradle
|
||||
|
||||
* [Developing plugins using Gradle](/tutorials/build_system.md)
|
||||
|
@ -6,6 +6,8 @@ title: Building Plugins with Gradle
|
||||
The [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin) Gradle plugin is the recommended solution for building IntelliJ plugins.
|
||||
The plugin takes care of the dependencies of your plugin project - both the base IDE and other plugin dependencies.
|
||||
|
||||
> **TIP** [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) makes it easier to create and maintain your IDE plugins, having the Gradle plugin already integrated and CI covered with GitHub Actions.
|
||||
|
||||
> **NOTE** If a new plugin will be Scala-based, a dedicated SBT plugin [sbt-idea-plugin](https://github.com/JetBrains/sbt-idea-plugin) is available.
|
||||
|
||||
The gradle-intellij-plugin provides tasks to run the IDE with your plugin and to publish your plugin to the [JetBrains Plugins Repository](https://plugins.jetbrains.com).
|
||||
|
@ -8,6 +8,8 @@ The IntelliJ IDEA Ultimate and Community editions bundle the necessary plugins t
|
||||
These IntelliJ IDEA plugins are _Gradle_ and _Plugin DevKit_, which are enabled by default.
|
||||
To verify these plugins are installed and enabled, see the help section about [Managing Plugins](https://www.jetbrains.com/help/idea/managing-plugins.html).
|
||||
|
||||
> **TIP** [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) makes it easier to create and maintain your IDE plugins, having the Gradle plugin already integrated and CI covered with GitHub Actions.
|
||||
|
||||
> **WARNING** When adding additional repositories to your Gradle build script, make sure to always use HTTPS protocol.
|
||||
|
||||
* bullet list
|
||||
|
22
tutorials/github_template.md
Normal file
22
tutorials/github_template.md
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
title: IntelliJ Platform Plugin Template
|
||||
---
|
||||
|
||||
[**IntelliJ Platform Plugin Template**][gh:ippt] is a repository that provides a pure boilerplate template
|
||||
to make it easier to create a new plugin project.
|
||||
|
||||
The main goal of this template is to speed up the setup phase of plugin development for both new and experienced
|
||||
developers by preconfiguring the project scaffold and CI, linking to the proper documentation pages, and keeping
|
||||
everything organized.
|
||||
|
||||
GitHub Template allows you to create a new repository from the scaffold without having to copy and paste content,
|
||||
clone repositories, or clear the history manually. All you have to do is click the <kbd>Use this template</kbd>
|
||||
button in the GitHub project page. After that GitHub Actions workflow will be triggered to override or remove any
|
||||
template-specific configurations, such as the plugin name, current changelog, etc.
|
||||
Once this is complete, the project is ready to be cloned to your local environment and opened with
|
||||
[IntelliJ IDEA][jb:download-ij].
|
||||
|
||||
For more details, please refer to the [IntelliJ Platform Plugin Template][gh:ippt] project documentation.
|
||||
|
||||
[gh:ippt]: https://github.com/JetBrains/intellij-platform-plugin-template
|
||||
[jb:download-ij]: https://www.jetbrains.com/idea/download
|
Loading…
x
Reference in New Issue
Block a user