IntelliJ Plugin Template is a repository that provides a pure boilerplate for creating a plugin project with ease
designed as a GitHub template repository (check the [Creating a repository from a template][gh-template] article).
<!-- Plugin description -->
**IntelliJ Plugin Template** is a repository that provides a pure boilerplate for creating a plugin project with ease
designed as a **GitHub Template Repository** (check the [Creating a repository from a template][gh-template] article).
The main goal for this Template is to speed up the setup phase of the plugin development for the new as well as existing
developers by preconfiguring the project scaffold, CI and linking to the proper documentation pages as well as keeping
developers by preconfiguring the project scaffold, CI and linking to the proper documentation pages and keeping
everything in the most straightforward manner.
<!-- Plugin description end -->
We can detail here the following parts:
We can highlight here the following parts:
- Gradle configuration
- Sample code:
@ -21,9 +23,21 @@ We can detail here the following parts:
- CI based on GitHub actions
- Release and changelog maintenance flow
## Getting started
## Getting Started
TODO
Before diving into the plugin development and everything that happens around, it is worth mentioning the fundamental
idea behind the GitHub Templates: by creating a new project using the current template, you start with no history
and no reference to this repository - it is the cut corner for creating a new repository with copy-pasting the content
or cloning repositories and clearing the history by your own.
The only thing that you have to do is clicking the **Use this template** button.
![Use this template][file:getting-started_use-this-template.png]
After creating your blank project from the template, there will be the [Template Cleanup][file:template_cleanup.yml]
workflow triggered to override or remove template-specific configuration, like plugin name, current changelog, etc.
As a last step, it is required to manually specify the `pluginName` and `pluginGroup` in the `gradle.properties` file.
## Gradle
@ -39,7 +53,10 @@ TODO
## Continuous Integration
TODO
Unit tests
Detekt
verifyPlugin
intellij-plugin-verifier
## Release Flow
@ -55,6 +72,10 @@ and inside of the Plugin Manager's item details.
There are many different methods of handling the project's changelog. One of them, used in the current template project,
is the [Keep a Changelog][keep-a-changelog] approach.
# Publishing Plugin
Cannot find org.jetbrains.plugins.template. Note that you need to upload the plugin to the repository at least once manually (to specify options like the license, repository URL etc.). Follow the instructions: https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/publishing_plugin.html
## Useful Links
- [IntelliJ Platform SDK DevGuide][sdk-docs]
@ -73,3 +94,6 @@ is the [Keep a Changelog][keep-a-changelog] approach.