Archives/JetBrains_intellij-platform-plugin-template
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-platform-plugin-template.git synced 2024-10-27 20:44:05 +00:00
Code Issues Projects Releases Wiki Activity

README.md: sync with current project state

Browse Source
This commit is contained in:
Jakub Chrzanowski 2023-04-12 22:47:35 +02:00 committed by Jakub Chrzanowski
parent ff1d4316c4
commit 702be82984
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -153,9 +153,10 @@ A generated IntelliJ Platform Plugin Template repository contains the following
. .
├── .github/ GitHub Actions workflows and Dependabot configuration files ├── .github/ GitHub Actions workflows and Dependabot configuration files
├── .run/ Predefined Run/Debug Configurations ├── .run/ Predefined Run/Debug Configurations
├── gradle
│ └── wrapper/ Gradle Wrapper
├── build/ Output build directory ├── build/ Output build directory
├── gradle
│ ├── wrapper/ Gradle Wrapper
│ └── libs.versions.toml Gradle version catalog
├── src Plugin sources ├── src Plugin sources
│ ├── main │ ├── main
│ │ ├── kotlin/ Kotlin production sources │ │ ├── kotlin/ Kotlin production sources
@ -192,16 +193,18 @@ It provides general information about the plugin, its dependencies, extensions,
<id>org.jetbrains.plugins.template</id> <id>org.jetbrains.plugins.template</id>
<name>Template</name> <name>Template</name>
<vendor>JetBrains</vendor> <vendor>JetBrains</vendor>
<depends>com.intellij.modules.platform</depends> <depends>com.intellij.modules.platform</depends>
<resource-bundle>messages.MyBundle</resource-bundle>
<extensions defaultExtensionNs="com.intellij"> <extensions defaultExtensionNs="com.intellij">
<applicationService serviceImplementation="..."/> <toolWindow factoryClass="..." id="..."/>
<projectService serviceImplementation="..."/>
</extensions> </extensions>
<projectListeners> <applicationListeners>
<listener class="..." topic="..."/> <listener class="..." topic="..."/>
</projectListeners> </applicationListeners>
</idea-plugin> </idea-plugin>
``` ```
@ -217,10 +220,12 @@ Therefore, the template contains only the following files:
. .
├── MyBundle.kt Bundle class providing access to the resources messages ├── MyBundle.kt Bundle class providing access to the resources messages
├── listeners ├── listeners
│ └── MyProjectManagerListener.kt Project Manager listener - handles project lifecycle │ └── MyFrameStateListener.kt Frame state listener — detects when IDE frame is opened/closed
└── services ├── services
├── MyApplicationService.kt Application-level service available for all projects │ └── MyProjectService.kt Project level service
└── MyProjectService.kt Project level service ├── toolWindow
│ └── MyToolWindowFactory.kt Tool window factory — creates tool window content
└
``` ```
These files are located in `src/main/kotlin`. These files are located in `src/main/kotlin`.
@ -415,7 +420,7 @@ When releasing an update, it is essential to let your users know what the new ve
The best way to do this is to provide release notes. The best way to do this 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: When they're provided, these lists are available in a few different places:
- the [CHANGELOG.md](./CHANGELOG.md) file, - the [CHANGELOG.md](./CHANGELOG.md) file,
- the [Releases page][gh:releases], - the [Releases page][gh:releases],
- the *What's new* section of JetBrains Marketplace Plugin page, - the *What's new* section of JetBrains Marketplace Plugin page,
@ -478,7 +483,7 @@ Next, it will notify users who are *watching* the repository, triggering the fin
Plugin Signing is a mechanism introduced in the 2021.2 release cycle to increase security in [JetBrains Marketplace](https://plugins.jetbrains.com) and all of our IntelliJ-based IDEs. Plugin Signing is a mechanism introduced in the 2021.2 release cycle to increase security in [JetBrains Marketplace](https://plugins.jetbrains.com) and all of our IntelliJ-based IDEs.
JetBrains Marketplace signing is designed to ensure that plugins are not modified over the course of the publishing and delivery pipeline. JetBrains Marketplace signing is designed to ensure that plugins aren't modified over the course of the publishing and delivery pipeline.
The current project provides a predefined plugin signing configuration that lets you sign and publish your plugin from the Continuous Integration (CI) and local environments. The current project provides a predefined plugin signing configuration that lets you sign and publish your plugin from the Continuous Integration (CI) and local environments.
All the configuration related to the signing should be provided using [environment variables](#environment-variables). All the configuration related to the signing should be provided using [environment variables](#environment-variables).