Archives
/
JetBrains_intellij-platform-plugin-template
mirror of https://github.com/JetBrains/intellij-platform-plugin-template
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove unnecessary new lines from the README

Browse Source
pull/31/head
Jakub Chrzanowski 4 years ago
parent 56ab172a19
commit 772a5eafd4
2 changed files with 24 additions and 66 deletions
Show Stats Download Patch File Download Diff File

3
.github/template-cleanup/README.md vendored
Unescape View File

@ -16,8 +16,7 @@
<!-- Plugin description --> <!-- Plugin description -->
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have. This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
extracted by the [Gradle](/build.gradle.kts) during the build process.
To keep everything working, do not remove `<!-- ... -->` sections. To keep everything working, do not remove `<!-- ... -->` sections.
<!-- Plugin description end --> <!-- Plugin description end -->

87
README.md
Unescape View File

@ -8,18 +8,14 @@
> **TL;DR:** Click the <kbd>Use this template</kbd> button and clone it in IntelliJ IDEA. > **TL;DR:** Click the <kbd>Use this template</kbd> button and clone it in IntelliJ IDEA.
<!-- Plugin description --> <!-- Plugin description -->
**IntelliJ Platform Plugin Template** is a repository that provides a pure boilerplate template to make it easier **IntelliJ Platform Plugin Template** is a repository that provides a pure boilerplate template to make it easier to create a new plugin project (check the [Creating a repository from a template][gh:template] article).
to create a new plugin project (check the [Creating a repository from a template][gh:template] article).
The main goal of this template is to speed up the setup phase of plugin development for both new and experienced 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.
developers by preconfiguring the project scaffold and CI, linking to the proper documentation pages, and keeping
everything organized.
[gh:template]: https://help.github.com/en/enterprise/2.20/user/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template [gh:template]: https://help.github.com/en/enterprise/2.20/user/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template
<!-- Plugin description end --> <!-- Plugin description end -->
If you're still not quite sure what this is all about, read our introduction: If you're still not quite sure what this is all about, read our introduction: [What is the IntelliJ Platform?][docs:intro]
[What is the IntelliJ Platform?][docs:intro]
> **TIP**: Click the <kbd>Watch</kbd> button on the top to be notified about releases containing new features and fixes. > **TIP**: Click the <kbd>Watch</kbd> button on the top to be notified about releases containing new features and fixes.
@ -39,40 +35,26 @@ In this README, we will highlight the following elements of template-project cre
## Getting started ## Getting started
Before we dive into plugin development and everything related to it, it's worth mentioning the benefits of using GitHub Before we dive into plugin development and everything related to it, it's worth mentioning the benefits of using GitHub Templates. By creating a new project using the current template, you start with no history and no reference to this repository. This allows you to create a new repository easily without having to copy and paste previous content, clone repositories, or clear the history manually.
Templates. By creating a new project using the current template, you start with no history and no reference
to this repository. This allows you to create a new repository easily without having to copy and paste previous content,
clone repositories, or clear the history manually.
All you have to do is click the <kbd>Use this template</kbd> button. All you have to do is click the <kbd>Use this template</kbd> button.
![Use this template][file:use-this-template.png] ![Use this template][file:use-this-template.png]
After using the template to create your blank project, the [Template Cleanup][file:template_cleanup.yml] workflow After using the template to create your blank project, the [Template Cleanup][file:template_cleanup.yml] 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].
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 the last step, you have to manually review the configuration variables described For the last step, you have to manually review the configuration variables described in the [gradle.properties][file:gradle.properties] file and *optionally* move sources from the *com.github.username.repository* package to the one that works best for you. Then you can get to work implementing your ideas.
in the [gradle.properties][file:gradle.properties] file and *optionally* move sources
from the *com.github.username.repository* package to the one that works best for you. Then you can get to work
implementing your ideas.
## Gradle configuration ## Gradle configuration
The recommended method for plugin development involves using the [Gradle][gradle] setup The recommended method for plugin development involves using the [Gradle][gradle] setup with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] installed. The gradle-intellij-plugin makes it possible to run the IDE with your plugin and to publish your plugin to the Marketplace Repository.
with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] installed. The gradle-intellij-plugin makes it possible
to run the IDE with your plugin and to publish your plugin to the Marketplace Repository.
A project built using the IntelliJ Platform Plugin Template includes a Gradle configuration that's already been set up. A project built using the IntelliJ Platform Plugin Template includes a Gradle configuration that's already been set up. Feel free to read through the [Using Gradle][docs:using-gradle] articles to get a better understanding of your build and to learn how to customize it.
Feel free to read through the [Using Gradle][docs:using-gradle] articles to get a better understanding of your build
and to learn how to customize it.
The most significant parts of the current configuration are: The most significant parts of the current configuration are:
- Configuration written with [Gradle Kotlin DSL][gradle-kotlin-dsl]. - Configuration written with [Gradle Kotlin DSL][gradle-kotlin-dsl].
- Kotlin support, with the option to write Java code. - Kotlin support, with the option to write Java code.
- Integration with the [gradle-changelog-plugin][gh:gradle-changelog-plugin], which automatically patches the change - Integration with the [gradle-changelog-plugin][gh:gradle-changelog-plugin], which automatically patches the change notes and description based on the `CHANGELOG.md` and `README.md` files.
notes and description based on the `CHANGELOG.md` and `README.md` files.
- Integration with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] for smoother development. - Integration with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] for smoother development.
- Code linting with [detekt][detekt]. - Code linting with [detekt][detekt].
- [Plugin publishing][docs:publishing] using the token. - [Plugin publishing][docs:publishing] using the token.
@ -90,8 +72,7 @@ The project-specific configuration file [gradle.properties][file:gradle.properti
| `platformVersion` | The version of the IntelliJ Platform IDE that will be used to build the plugin. | | `platformVersion` | The version of the IntelliJ Platform IDE that will be used to build the plugin. |
| `platformDownloadSources` | IDE sources downloaded while initializing the Gradle build. | | `platformDownloadSources` | IDE sources downloaded while initializing the Gradle build. |
The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details.
check its documentation for more details.
## Plugin template structure ## Plugin template structure
@ -117,12 +98,10 @@ A generated IntelliJ Platform Plugin Template repository contains the following
└── resources/ Resources - plugin.xml, icons, messages └── resources/ Resources - plugin.xml, icons, messages
``` ```
In addition to the configuration files, the most important part is the `src` directory, which contains our In addition to the configuration files, the most important part is the `src` directory, which contains our implementation and the manifest for our plugin – [plugin.xml][file:plugin.xml].
implementation and the manifest for our plugin – [plugin.xml][file:plugin.xml].
## Plugin configuration file ## Plugin configuration file
The plugin configuration file is a [plugin.xml][file:plugin.xml] file located in the `src/main/resources/META-INF` The plugin configuration file is a [plugin.xml][file:plugin.xml] file located in the `src/main/resources/META-INF` directory. It provides general information about the plugin, its dependencies, extensions, and listeners.
directory. It provides general information about the plugin, its dependencies, extensions, and listeners.
```xml ```xml
<idea-plugin> <idea-plugin>
@ -146,9 +125,7 @@ You can read more about this file in the [IntelliJ Platform SDK DevGuide][docs:p
## Sample code ## Sample code
The prepared template provides as little code as possible because it is impossible for a general scaffold to fulfill The prepared template provides as little code as possible because it is impossible for a general scaffold to fulfill all the specific requirements for all types of plugins (language support, build tools, VCS related tools). The template contains only the following files:
all the specific requirements for all types of plugins (language support, build tools, VCS related tools).
The template contains only the following files:
``` ```
. .
@ -160,14 +137,11 @@ The template contains only the following files:
└── MyProjectService.kt Project level service └── MyProjectService.kt Project level service
``` ```
These files are located in `src/main/kotlin`. This location indicates the language being used. So if you decide to use These files are located in `src/main/kotlin`. This location indicates the language being used. So if you decide to use Java instead, sources should be located in the `src/main/java` directory.
Java instead, sources should be located in the `src/main/java` directory.
## Continuous integration ## Continuous integration
Continuous integration depends on [GitHub Actions][gh:actions], which are a set of workflows that make it possible Continuous integration depends on [GitHub Actions][gh:actions], which are a set of workflows that make it possible to automate your testing and release process. Thanks to such automation, you can delegate the testing and verification phases to the CI and instead focus on development (and writing more tests).
to automate your testing and release process. Thanks to such automation, you can delegate the testing and verification
phases to the CI and instead focus on development (and writing more tests).
In the `.github/workflows` directory, you can find definitions for the following GitHub Actions workflows: In the `.github/workflows` directory, you can find definitions for the following GitHub Actions workflows:
@ -193,45 +167,30 @@ All of the workflow files have accurate documentation, so it's a good idea to ta
### Changelog maintenance ### Changelog maintenance
When releasing an update, it is important to let your users know what the new version offers. The best way to do this When releasing an update, it is important to let your users know what the new version offers. The best way to do this is to provide release notes.
is to provide release notes.
The changelog is a curated list that contains information about any new features, fixes, and deprecations. The changelog is a curated list that contains information about any new features, fixes, and deprecations. When they are provided, these lists are available in a few different places: the [CHANGELOG.md](./CHANGELOG.md) file, the [Releases page][gh:releases], the *What's new* section of the Marketplace Plugin page, and inside of the Plugin Manager's item details.
When they are provided, these lists are available in a few different places: the [CHANGELOG.md](./CHANGELOG.md) file,
the [Releases page][gh:releases], the *What's new* section of the Marketplace Plugin page,
and inside of the Plugin Manager's item details.
There are many methods for handling the project's changelog. The one, used in the current template project There are many methods for handling the project's changelog. The one, used in the current template project is the [Keep a Changelog][keep-a-changelog] approach.
is the [Keep a Changelog][keep-a-changelog] approach.
### Release flow ### Release flow
The release process depends on the workflows already described above. When your main branch receives a new pull request The release process depends on the workflows already described above. When your main branch receives a new pull request or a regular push, the [Build](.github/workflows/build.yml) workflow runs multiple tests on your plugin and prepares a draft release.
or a regular push, the [Build](.github/workflows/build.yml) workflow runs multiple tests on your plugin and prepares
a draft release.
![Release draft][file:draft-release.png] ![Release draft][file:draft-release.png]
The draft release is a working copy of a release, which you can review before publishing. It includes a predefined title The draft release is a working copy of a release, which you can review before publishing. It includes a predefined title and git tag, which is the current version of the plugin, for example, `v0.0.1`. The changelog is provided automatically using the [gradle-changelog-plugin][gh:gradle-changelog-plugin]. An artifact file is also built with the plugin attached. Every new Build overrides the previous draft to keep your *Releases* page clean.
and git tag, which is the current version of the plugin, for example, `v0.0.1`. The changelog is provided
automatically using the [gradle-changelog-plugin][gh:gradle-changelog-plugin]. An artifact file is also built with
the plugin attached. Every new Build overrides the previous draft to keep your *Releases* page clean.
When you edit the draft and use the <kbd>Publish release</kbd> button, GitHub will tag your repository with the given When you edit the draft and use the <kbd>Publish release</kbd> button, GitHub will tag your repository with the given version and add a new entry to the Releases tab. Next, it will notify users that are *watching* the repository, and it will trigger the final [Release](.github/workflows/release.yml) workflow.
version and add a new entry to the Releases tab. Next, it will notify users that are *watching* the repository, and it
will trigger the final [Release](.github/workflows/release.yml) workflow.
### Publishing the plugin ### Publishing the plugin
Releasing a plugin to the Marketplace is a straightforward operation that uses the `publishPlugin` Gradle task Releasing a plugin to the Marketplace is a straightforward operation that uses the `publishPlugin` Gradle task provided by the [gradle-intellij-plugin][gh:gradle-intellij-plugin]. The [Release](.github/workflows/release.yml) workflow automates this process by running the task when a new release appears in the GitHub Releases section.
provided by the [gradle-intellij-plugin][gh:gradle-intellij-plugin]. The [Release](.github/workflows/release.yml)
workflow automates this process by running the task when a new release appears in the GitHub Releases section.
> **TIP**: Set a suffix to the plugin version to publish it in the custom repository channel, i.e. `v1.0.0-beta` will > **TIP**: Set a suffix to the plugin version to publish it in the custom repository channel, i.e. `v1.0.0-beta` will
> push your plugin to the `beta` [release channel][docs:release-channel]. > push your plugin to the `beta` [release channel][docs:release-channel].
The authorization process relies on the `PUBLISH_TOKEN` secret environment variable, which has to be acquired The authorization process relies on the `PUBLISH_TOKEN` secret environment variable, which has to be acquired through the Secrets section of the repository Settings.
through the Secrets section of the repository Settings.
![Settings > Secrets][file:settings-secrets.png] ![Settings > Secrets][file:settings-secrets.png]

Write Preview
Loading…
Cancel
Save