[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-7337":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":16,"stars7d":17,"stars30d":18,"stars90d":16,"forks30d":16,"starsTrendScore":19,"compositeScore":20,"rankGlobal":10,"rankLanguage":10,"license":21,"archived":22,"fork":22,"defaultBranch":23,"hasWiki":22,"hasPages":22,"topics":24,"createdAt":10,"pushedAt":10,"updatedAt":32,"readmeContent":33,"aiSummary":34,"trendingCount":16,"starSnapshotCount":16,"syncStatus":17,"lastSyncTime":35,"discoverSource":36},7337,"intellij-platform-plugin-template","JetBrains\u002Fintellij-platform-plugin-template","JetBrains","Template repository for creating plugins for IntelliJ Platform","",null,"Kotlin",3740,810,139,25,0,2,14,1,30.73,"Apache License 2.0",false,"main",[25,26,27,28,29,30,31],"intellij","intellij-idea","intellij-idea-plugin","intellij-platform","intellij-plugin","intellij-plugins","jetbrains-plugin","2026-06-12 02:01:38","# IntelliJ Platform Plugin Template\n\n[![official JetBrains project](https:\u002F\u002Fjb.gg\u002Fbadges\u002Fofficial.svg)][jb:github]\n[![Twitter Follow](https:\u002F\u002Fimg.shields.io\u002Fbadge\u002Ffollow-%40JBPlatform-1DA1F2?logo=twitter)](https:\u002F\u002Fx.com\u002FJBPlatform)\n[![Build](https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-platform-plugin-template\u002Fworkflows\u002FBuild\u002Fbadge.svg)][gh:build]\n\n![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-dark]\n![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-light]\n\n> [!NOTE]\n> Click the \u003Ckbd>Use this template\u003C\u002Fkbd> button and clone it in IntelliJ IDEA.\n\n**IntelliJ Platform Plugin Template** is a repository that provides a pure template to make it easier to create a new plugin project (check the [Creating a repository from a template][gh:template] article).\n\nThe 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.\n\n[gh:template]: https:\u002F\u002Fdocs.github.com\u002Fen\u002Frepositories\u002Fcreating-and-managing-repositories\u002Fcreating-a-repository-from-a-template\n\nIf you're still not quite sure what this is all about, read our introduction: [What is the IntelliJ Platform?][docs:intro]\n\n> [!NOTE]\n> Click the \u003Ckbd>Watch\u003C\u002Fkbd> button on the top to be notified about releases containing new features and fixes.\n\n### Table of contents\n\nIn this README, we will highlight the following elements of template-project creation:\n\n- [Getting started](#getting-started)\n- [Gradle configuration](#gradle-configuration)\n- [Plugin template structure](#plugin-template-structure)\n- [Plugin configuration file](#plugin-configuration-file)\n- [Sample code](#sample-code):\n  - startup activity – project-open sample\n  - services – project-level service\n  - tool window – sample UI entry point\n- [Testing](#testing)\n  - [Functional tests](#functional-tests)\n  - [UI tests](#ui-tests)\n- [Predefined Run\u002FDebug configurations](#predefined-rundebug-configurations)\n- [Continuous integration](#continuous-integration) based on GitHub Actions\n  - [Dependencies management](#dependencies-management) with Dependabot\n  - [Changelog maintenance](#changelog-maintenance) with the Gradle Changelog Plugin\n  - [Release flow](#release-flow) using GitHub Releases\n  - [Plugin signing](#plugin-signing) with Marketplace signing\n  - [Publishing the plugin](#publishing-the-plugin) with the IntelliJ Platform Gradle Plugin\n- [FAQ](#faq)\n- [Useful links](#useful-links)\n\n\n## Getting started\n\nBefore we dive into plugin development and everything related to it, it's worth mentioning the benefits of using GitHub Templates.\nBy creating a new project using the current template, you start with no history or reference to this repository.\nThis allows you to create a new repository easily without copying and pasting previous content, cloning repositories, or clearing the history manually.\n\nAll you have to do is click the \u003Ckbd>Use this template\u003C\u002Fkbd> button (you must be logged in with your GitHub account).\n\n![Use this template][file:use-this-template.png]\n\nAfter 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.\nOnce this is complete, open the newly created project's _Settings | Actions | General_ page and enable option _Allow GitHub Actions to create and approve pull requests_.\n\nNow the project is ready to be cloned to your local environment and opened with [IntelliJ IDEA][jb:download-ij].\n\nThe most convenient way for getting your new project from GitHub is the \u003Ckbd>Get from VCS\u003C\u002Fkbd> action available on the Welcome Screen, where you can filter your GitHub repository by its name.\n\n![Get from Version Control][file:get-from-version-control]\n\nThe next step, after opening your project in IntelliJ IDEA, is to set the proper \u003Ckbd>SDK\u003C\u002Fkbd> to Java in version `21` within the [Project Structure settings][docs:project-structure-settings].\n\n![Project Structure — SDK][file:project-structure-sdk.png]\n\nFor the last step, review the project metadata in [`gradle.properties`][file:gradle.properties] and [`plugin.xml`][file:plugin.xml], then *optionally* move sources from the generated package to the one that works best for you.\nThen you can get to work implementing your ideas.\n\n> [!NOTE]\n> To use Java in your plugin, create the `\u002Fsrc\u002Fmain\u002Fjava` directory.\n\n\n## Gradle configuration\n\nThe recommended method for plugin development involves using the [Gradle][gradle] setup with the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin] installed.\nThe IntelliJ Platform Gradle Plugin makes it possible to run the IDE with your plugin and publish your plugin to JetBrains Marketplace.\n\n> [!NOTE]\n> Make sure to always upgrade to the latest version of IntelliJ Platform Gradle Plugin.\n\nA project built using the IntelliJ Platform Plugin Template includes a Gradle configuration already set up.\nFeel free to read through the [Using Gradle][docs:using-gradle] articles to understand your build better and learn how to customize it.\n\nThe most significant parts of the current configuration are:\n- Integration with the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin] for smoother development.\n- Repository configuration moved to [`settings.gradle.kts`][file:settings.gradle.kts] using the IntelliJ Platform repositories extension.\n- Configuration written with [Gradle Kotlin DSL][gradle:kotlin-dsl].\n- Support for Kotlin and Java implementation.\n- Plugin and dependency versions are declared directly in the Gradle build files.\n- Integration with the [gradle-changelog-plugin][gh:gradle-changelog-plugin], which automatically patches the change notes based on the `CHANGELOG.md` file.\n- [Plugin publishing][docs:publishing] through the `publishPlugin` task and GitHub Actions workflows.\n\nFor more details regarding Kotlin integration, please see [Kotlin for Plugin Developers][docs:kotlin] in the IntelliJ Platform Plugin SDK documentation.\n\n### Gradle properties\n\nThe project-specific configuration file [`gradle.properties`][file:gradle.properties] starts with values expected to vary between repositories created from this template:\n\n| Property name         | Description                                                                                          |\n|-----------------------|------------------------------------------------------------------------------------------------------|\n| `group`               | Project group and default base package for the sample sources.                                      |\n| `version`             | Current plugin version in [SemVer][semver] format.                                                   |\n| `pluginRepositoryUrl` | Repository URL used for generating URLs by the [Gradle Changelog Plugin][gh:gradle-changelog-plugin] |\n\nThe remaining plugin metadata lives closer to where it is used:\n- [`settings.gradle.kts`][file:settings.gradle.kts] declares Gradle plugin versions and repository management.\n- [`build.gradle.kts`][file:build.gradle.kts] declares the target IntelliJ Platform version and project dependencies.\n- [`plugin.xml`][file:plugin.xml] contains the plugin `id`, `name`, `vendor`, `description`, and extension registrations.\n\nIt also configures Gradle build behavior flags, such as:\n\n| Property name                                    | Value   | Description                                                                                    |\n|--------------------------------------------------|---------|------------------------------------------------------------------------------------------------|\n| `kotlin.stdlib.default.dependency`               | `false` | Opt-out flag for bundling [Kotlin standard library][docs:kotlin-stdlib]                        |\n| `org.gradle.configuration-cache`                 | `true`  | Enable [Gradle Configuration Cache][gradle:configuration-cache]                                |\n| `org.gradle.caching`                             | `true`  | Enable [Gradle Build Cache][gradle:build-cache]                                                |\n\n### Environment variables\n\nSome values used during signing and publishing should not be stored in project files.\n\nProvide them through local *Run\u002FDebug Configurations* or on CI, for example in GitHub under `Settings > Secrets and variables > Actions`.\n\nThe current template uses the following variables for the [plugin signing](#plugin-signing) and [publishing](#publishing-the-plugin) flow:\n\n| Environment variable name | Description                                                                                                  |\n|---------------------------|--------------------------------------------------------------------------------------------------------------|\n| `PRIVATE_KEY`             | Certificate private key, should contain: `-----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY-----` |\n| `PRIVATE_KEY_PASSWORD`    | Password used for encrypting the certificate file.                                                           |\n| `CERTIFICATE_CHAIN`       | Certificate chain, should contain: `-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----`                |\n| `PUBLISH_TOKEN`           | Publishing token generated in your JetBrains Marketplace profile dashboard.                                  |\n\nFor more details on how to generate proper values, check the relevant sections mentioned above.\n\nTo configure GitHub secret environment variables, go to the `⚙️ Settings > Secrets and variables > Actions` section of your project repository:\n\n![Settings > Secrets][file:settings-secrets.png]\n\n## Plugin template structure\n\nA generated IntelliJ Platform Plugin Template repository contains the following content structure:\n\n```\n.\n├── .github\u002F                GitHub Actions workflows and Dependabot configuration files\n├── .run\u002F                   Predefined Run\u002FDebug Configurations\n├── gradle\n│   └── wrapper\u002F            Gradle Wrapper\n├── src                     Plugin sources\n│   ├── main\n│   │   ├── kotlin\u002F         Kotlin production sources\n│   │   └── resources\u002F      Resources - plugin.xml, icons, messages\n│   └── test\n│       ├── kotlin\u002F         Kotlin test sources\n│       └── testData\u002F       Test data used by tests\n├── .gitignore              Git ignoring rules\n├── build.gradle.kts        Gradle configuration\n├── CHANGELOG.md            Full change history\n├── gradle.properties       Gradle configuration properties\n├── gradlew                 *nix Gradle Wrapper script\n├── gradlew.bat             Windows Gradle Wrapper script\n├── LICENSE                 License, MIT by default\n├── README.md               README\n└── settings.gradle.kts     Gradle project settings and repositories\n```\n\nIn addition to the configuration files, the most crucial part is the `src` directory, which contains our implementation and the manifest for our plugin – [plugin.xml][file:plugin.xml].\n\n> [!NOTE]\n> To use Java in your plugin, create the `\u002Fsrc\u002Fmain\u002Fjava` directory.\n\n\n## Plugin configuration file\n\nThe plugin configuration file is a [plugin.xml][file:plugin.xml] file located in the `src\u002Fmain\u002Fresources\u002FMETA-INF` directory.\nIt provides general information about the plugin, its dependencies, and its extensions.\nMaintain the plugin description directly in this file, using HTML wrapped in CDATA when needed.\n\n> [!NOTE]\n> When using this template for a real plugin, replace the placeholder description with content that describes the final plugin.\n\n```xml\n\u003Cidea-plugin>\n  \u003Cid>org.jetbrains.plugins.template\u003C\u002Fid>\n  \u003Cname>IntelliJ Platform Plugin Template\u003C\u002Fname>\n  \u003Cvendor>JetBrains\u003C\u002Fvendor>\n  \u003Cdescription>\u003C![CDATA[\n    \u003Cp>Plugin description in HTML.\u003C\u002Fp>\n  ]]>\u003C\u002Fdescription>\n\n  \u003Cdepends>com.intellij.modules.platform\u003C\u002Fdepends>\n\n  \u003Cresource-bundle>messages.MyBundle\u003C\u002Fresource-bundle>\n\n  \u003Cextensions defaultExtensionNs=\"com.intellij\">\n    \u003CtoolWindow factoryClass=\"...\" id=\"...\"\u002F>\n    \u003CpostStartupActivity implementation=\"...\"\u002F>\n  \u003C\u002Fextensions>\n\u003C\u002Fidea-plugin>\n```\n\nYou can read more about this file in the [Plugin Configuration File][docs:plugin.xml] section of our documentation.\n\n\n## Sample code\n\nThe 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).\nTherefore, the template contains only the following files:\n\n```\n.\n├── startup\n│   └── MyProjectActivity.kt                Project startup activity\n├── services\n│   └── MyProjectService.kt                 Project-level service\n├── toolWindow\n│   └── MyToolWindowFactory.kt              Tool window factory — creates tool window content\n└── MyBundle.kt                             Bundle class providing access to the resources messages\n```\n\nThese files are located in `src\u002Fmain\u002Fkotlin`.\nThis location indicates the language being used.\nSo if you decide to use Java instead (or in addition to Kotlin), these sources should be located in the `src\u002Fmain\u002Fjava` directory.\n\n> [!TIP]\n> It is possible to use the [IntelliJ Platform Icons](https:\u002F\u002Fjb.gg\u002Fnew-ui-icons) in your plugin.\n\nTo start with the actual implementation, you may check our [IntelliJ Platform SDK DevGuide][docs], which contains an introduction to the essential areas of the plugin development together with dedicated tutorials.\n\n> [!WARNING]\n> Remember to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.\n\nFor those who value example codes the most, there are also available [IntelliJ SDK Code Samples][gh:code-samples] and [IntelliJ Platform Explorer][jb:ipe] – a search tool for browsing Extension Points inside existing implementations of open-source IntelliJ Platform plugins.\n\n## Testing\n\n[Testing plugins][docs:testing-plugins] is an essential part of the plugin development to make sure that everything works as expected between IDE releases and plugin refactorings.\nThe IntelliJ Platform Plugin Template project ships with functional test examples and leaves UI testing setup to the plugin author.\n\n### Functional tests\n\nMost of the IntelliJ Platform codebase tests are model-level, run in a headless environment using an actual IDE instance.\nThe tests usually test a feature as a whole rather than individual functions that comprise its implementation, like in unit tests.\n\nIn `src\u002Ftest\u002Fkotlin`, you will find a basic `MyPluginTest` test that utilizes `BasePlatformTestCase` and runs a few checks against the XML files to indicate an example operation of creating files on the fly or reading them from `src\u002Ftest\u002FtestData\u002Frename` test resources.\n\n> [!NOTE]\n> Run your tests using predefined *Run Tests* configuration or by invoking the `.\u002Fgradlew check` Gradle task.\n\n### UI tests\n\nIf your plugin provides complex user interfaces, you should consider covering them with tests and the functionality they use.\n\nThe template does not wire UI testing into the Gradle build by default anymore.\nIf you need UI coverage, start with the IntelliJ Platform SDK guides for [Integration Tests][docs:integration-tests] and [Integration Tests: UI Testing][docs:integration-tests-ui], then add your own test source set, Gradle tasks, and CI workflow for the operating systems you support.\n\n\n## Predefined Run\u002FDebug configurations\n\nWithin the default project structure, there is a `.run` directory provided containing predefined *Run\u002FDebug configurations* that expose corresponding Gradle tasks:\n\n![Run\u002FDebug configurations][file:run-debug-configurations.png]\n\n| Configuration name | Description                                                                                                                                                                         |\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Run Plugin         | Runs [`:runIde`][gh:intellij-platform-gradle-plugin-runIde] IntelliJ Platform Gradle Plugin task. Use the *Debug* icon for plugin debugging.                                        |\n| Run Tests          | Runs [`:check`][gradle:lifecycle-tasks] Gradle task.                                                                                                                                |\n| Run Verifications  | Runs [`:verifyPlugin`][gh:intellij-platform-gradle-plugin-verifyPlugin] IntelliJ Platform Gradle Plugin task to check the plugin compatibility against the specified IntelliJ IDEs. |\n\n> [!NOTE]\n> You can find the logs from the running task in the `idea.log` tab.\n>\n> ![Run\u002FDebug configuration logs][file:run-logs.png]\n\n\n## Continuous integration\n\nContinuous integration depends on [GitHub Actions][gh:actions], a set of workflows that make it possible to automate your testing and release process.\nThanks to such automation, you can delegate the testing and verification phases to the Continuous Integration (CI) and instead focus on development (and writing more tests).\n\n> [!NOTE]\n> To ensure the \"Create Pull Request\" step functions correctly in the \"Publish Plugin\" job, make sure to enable \"Read and write permissions\" for actions by navigating to `⚙️ Settings > Actions > General > Workflow permissions`.\n\n\nIn the `.github\u002Fworkflows` directory, you can find definitions for the following GitHub Actions workflows:\n\n- [Build](.github\u002Fworkflows\u002Fbuild.yml)\n  - Triggered on `push` and `pull_request` events.\n  - Builds the plugin with the `buildPlugin` Gradle task and uploads the plugin ZIP as a workflow artifact.\n  - Runs the `check` Gradle task in a dedicated test job.\n  - Runs the `verifyPlugin` Gradle task in a dedicated verification job.\n  - Prepares a draft release of the GitHub Releases page for manual verification.\n- [Release](.github\u002Fworkflows\u002Frelease.yml)\n  - Triggered on `prereleased` and `released` events.\n  - Updates `CHANGELOG.md` with the published release notes when a release body is provided.\n  - Signs the plugin with a provided certificate before publishing.\n  - Publishes the plugin to JetBrains Marketplace using the provided `PUBLISH_TOKEN`.\n  - Uploads the built plugin distribution as a GitHub release asset.\n  - Creates a pull request with the patched changelog when needed.\n- [Template Cleanup](.github\u002Fworkflows\u002Ftemplate-cleanup.yml)\n  - Triggered once on the `push` event when a new template-based repository has been created.\n  - Overrides the scaffold with files from the `.github\u002Ftemplate-cleanup` directory.\n  - Overrides JetBrains-specific sentences or package names with ones specific to the target repository.\n  - Removes redundant files.\n\nAll the workflow files include inline documentation, so it's a good idea to take a look through their sources.\n\n### Dependencies management\n\nThis template keeps dependency management explicit and local to the Gradle files that use it:\n- [`settings.gradle.kts`][file:settings.gradle.kts] declares Gradle plugin versions and repositories.\n- [`build.gradle.kts`][file:build.gradle.kts] declares the target IntelliJ Platform version and project dependencies.\n- [`gradle.properties`][file:gradle.properties] stores repository-specific metadata shared by the build and CI workflows.\n\n> [!NOTE]\n> To add a regular library dependency, declare it directly in the `dependencies { ... }` block:\n>\n> ```kotlin\n> dependencies {\n>   implementation(\"group:artifact:version\")\n> }\n> ```\n>\n> Add IntelliJ Platform plugin or module dependencies through the `intellijPlatform { ... }` dependency extension described in the [IntelliJ Platform Gradle Plugin documentation][gh:intellij-platform-gradle-plugin-docs].\n\nKeeping the project in good shape and having all the dependencies up to date requires time and effort, but it is possible to automate that process using [Dependabot][gh:dependabot].\n\nDependabot is a bot provided by GitHub that checks build configuration files for outdated or insecure dependencies.\nWhen an update is available, it creates a new pull request providing [the proper change][gh:dependabot-pr].\n\n> [!NOTE]\n> Dependabot supports [Gradle Wrapper updates][gh:dependabot-supported-ecosystems].\n> To update Gradle manually, check the [Gradle Releases][gradle:releases] page and run\n> ```bash\n> .\u002Fgradlew wrapper --gradle-version \u003Cversion> && .\u002Fgradlew wrapper\n> ```\n\n### Changelog maintenance\n\nWhen releasing an update, it is essential to let your users know what the new version offers.\nThe best way to do this is to provide release notes.\n\nThe changelog is a curated list that contains information about any new features, fixes, and deprecations.\nWhen they're provided, these lists are available in a few different places:\n- the [CHANGELOG.md](.\u002FCHANGELOG.md) file,\n- the [Releases page][gh:releases],\n- the *What's new* section of the JetBrains Marketplace Plugin page,\n- and inside the Plugin Manager's item details.\n\nThere are many methods for handling the project's changelog.\nThe one used in the current template project is the [Keep a Changelog][keep-a-changelog] approach.\n\nThe [Gradle Changelog Plugin][gh:gradle-changelog-plugin] takes care of propagating information provided within the [CHANGELOG.md](.\u002FCHANGELOG.md) to the [IntelliJ Platform Gradle Plugin][gh:intellij-platform-gradle-plugin].\nYou only have to take care of writing down the actual changes in proper sections of the `[Unreleased]` section.\n\nYou start with an almost empty changelog:\n\n```\n# YourPlugin Changelog\n\n## [Unreleased]\n### Added\n- Initial scaffold created from [IntelliJ Platform Plugin Template](https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-platform-plugin-template)\n```\n\nNow proceed with providing more entries to the `Added` group, or any other one that suits your change the most (see [How do I make a good changelog?][keep-a-changelog-how] for more details).\n\nWhen releasing a plugin update, you don't have to care about bumping the `[Unreleased]` header to the upcoming version – it will be handled automatically on the Continuous Integration (CI) after you publish your plugin.\nGitHub Actions will swap it and provide you with an empty section for the next release so that you can proceed with your development:\n\n```\n# YourPlugin Changelog\n\n## [Unreleased]\n\n## [0.0.1]\n### Added\n- An awesome feature\n- Initial scaffold created from [IntelliJ Platform Plugin Template](https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-platform-plugin-template)\n\n### Fixed\n- One annoying bug\n```\n\nTo configure how the Changelog plugin behaves, i.e., to create headers with the release date, see the [Gradle Changelog Plugin][gh:gradle-changelog-plugin] README file.\n\n### Release flow\n\nThe release process depends on the workflows already described above.\nWhen your main branch receives a new pull request or a direct push, the [Build](.github\u002Fworkflows\u002Fbuild.yml) workflow runs multiple tests on your plugin and prepares a draft release.\n\n![Release draft][file:draft-release.png]\n\nThe draft release is a working copy of a release, which you can review before publishing.\nIt uses the current plugin version from [`gradle.properties`][file:gradle.properties] as both the title and git tag, for example, `0.0.1`.\nThe changelog is provided automatically using the [gradle-changelog-plugin][gh:gradle-changelog-plugin].\nThe built plugin archive is uploaded as a workflow artifact during the Build run rather than attached to the draft release itself.\nEvery new Build overrides the previous draft to keep your *Releases* page clean.\n\nWhen you edit the draft and use the \u003Ckbd>Publish release\u003C\u002Fkbd> button, GitHub will tag your repository with the given version and add a new entry to the Releases tab.\nNext, it will notify users who are *watching* the repository, triggering the final [Release](.github\u002Fworkflows\u002Frelease.yml) workflow.\n\n### Plugin signing\n\nPlugin Signing is a mechanism introduced in the 2021.2 release cycle to increase security in [JetBrains Marketplace](https:\u002F\u002Fplugins.jetbrains.com) and all of our IntelliJ-based IDEs.\n\nJetBrains Marketplace signing is designed to ensure that plugins aren't modified over the course of the publishing and delivery pipeline.\n\nThe current template keeps signing configuration out of `build.gradle.kts` and relies on the standard environment variables consumed by the IntelliJ Platform Gradle Plugin.\nThat allows you to sign and publish your plugin from both the Continuous Integration (CI) and local environments without checking secrets into VCS.\n\nTo find out how to generate signing certificates, check the [Plugin Signing][docs:plugin-signing] section in the IntelliJ Platform Plugin SDK documentation.\n\n### Publishing the plugin\n\n> [!TIP]\n> Make sure to follow all guidelines listed in [Publishing a Plugin][docs:publishing] to follow all recommended and required steps.\n\nReleasing a plugin to [JetBrains Marketplace](https:\u002F\u002Fplugins.jetbrains.com) is a straightforward operation that uses the `publishPlugin` Gradle task provided by the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin-docs].\nIn addition, the [Release](.github\u002Fworkflows\u002Frelease.yml) workflow automates this process by running the task when a new release appears in the GitHub Releases section.\n\n> [!NOTE]\n> If you need custom Marketplace channels or additional publishing options, add explicit publishing configuration to [`build.gradle.kts`][file:build.gradle.kts] as described in the [publishing documentation][docs:publishing].\n\nThe authorization process relies on the `PUBLISH_TOKEN` secret environment variable, specified in the `⚙️ Settings > Secrets and variables > Actions` section of your project repository.\n\nYou can get that token in your JetBrains Marketplace profile dashboard in the [My Tokens][jb:my-tokens] tab.\n\n> [!WARNING]\n> Before using the automated deployment process, it is necessary to manually create a new plugin in JetBrains Marketplace to specify options like the license, repository URL, etc.\n> Please follow the [Publishing a Plugin][docs:publishing] instructions.\n\n\n## FAQ\n\n### How to use Java in my project?\n\nJava language is supported by default along with Kotlin.\nInitially, the `\u002Fsrc\u002Fmain\u002Fkotlin` directory is available with minimal examples.\nYou can still replace it or add the `\u002Fsrc\u002Fmain\u002Fjava` directory to start working with Java language instead.\n\n### How to disable *tests* or *build* job using the `[skip ci]` commit message?\n\nSince February 2021, GitHub Actions [has supported the skip CI feature][github-actions-skip-ci].\nIf the message contains one of the following strings: `[skip ci]`, `[ci skip]`, `[no ci]`, `[skip actions]`, or `[actions skip]` – workflows will not be triggered.\n\n### Why does the draft release no longer contain a built plugin artifact?\n\nAll binaries created by the workflows are still available as workflow artifacts together with failed test reports or Plugin Verifier results.\nThat approach gives more possibilities for testing and debugging pre-releases, for example, in your local environment.\n\n## Useful links\n\n- [IntelliJ Platform Plugin SDK][docs]\n- [IntelliJ Platform Gradle Plugin Documentation][gh:intellij-platform-gradle-plugin-docs]\n- [IntelliJ Platform Explorer][jb:ipe]\n- [JetBrains Marketplace Quality Guidelines][jb:quality-guidelines]\n- [IntelliJ Platform UI Guidelines][jb:ui-guidelines]\n- [JetBrains Marketplace Paid Plugins][jb:paid-plugins]\n- [Kotlin UI DSL][docs:kotlin-ui-dsl]\n- [IntelliJ SDK Code Samples][gh:code-samples]\n- [JetBrains Platform Slack][jb:slack]\n- [JetBrains Platform Twitter][jb:twitter]\n- [IntelliJ IDEA Open API and Plugin Development Forum][jb:forum]\n- [Keep a Changelog][keep-a-changelog]\n- [GitHub Actions][gh:actions]\n\n[docs]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij?from=IJPluginTemplate\n[docs:intro]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fintellij-platform.html?from=IJPluginTemplate\n[docs:kotlin-ui-dsl]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fkotlin-ui-dsl-version-2.html?from=IJPluginTemplate\n[docs:kotlin]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fusing-kotlin.html?from=IJPluginTemplate\n[docs:kotlin-stdlib]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fusing-kotlin.html?from=IJPluginTemplate#kotlin-standard-library\n[docs:plugin.xml]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fplugin-configuration-file.html?from=IJPluginTemplate\n[docs:publishing]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fpublishing-plugin.html?from=IJPluginTemplate\n[docs:using-gradle]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fdeveloping-plugins.html?from=IJPluginTemplate\n[docs:plugin-signing]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fplugin-signing.html?from=IJPluginTemplate\n[docs:project-structure-settings]: https:\u002F\u002Fwww.jetbrains.com\u002Fhelp\u002Fidea\u002Fproject-settings-and-structure.html\n[docs:testing-plugins]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Ftesting-plugins.html?from=IJPluginTemplate\n[docs:integration-tests]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fintegration-tests.html?from=IJPluginTemplate\n[docs:integration-tests-ui]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Fintegration-tests-ui.html?from=IJPluginTemplate\n\n[file:build.gradle.kts]: .\u002Fbuild.gradle.kts\n[file:draft-release.png]: .\u002F.github\u002Freadme\u002Fdraft-release.png\n[file:get-from-version-control]: .\u002F.github\u002Freadme\u002Fget-from-version-control.png\n[file:gradle.properties]: .\u002Fgradle.properties\n[file:intellij-platform-plugin-template-dark]: .\u002F.github\u002Freadme\u002Fintellij-platform-plugin-template-dark.svg#gh-dark-mode-only\n[file:intellij-platform-plugin-template-light]: .\u002F.github\u002Freadme\u002Fintellij-platform-plugin-template-light.svg#gh-light-mode-only\n[file:project-structure-sdk.png]: .\u002F.github\u002Freadme\u002Fproject-structure-sdk.png\n[file:plugin.xml]: .\u002Fsrc\u002Fmain\u002Fresources\u002FMETA-INF\u002Fplugin.xml\n[file:run-debug-configurations.png]: .\u002F.github\u002Freadme\u002Frun-debug-configurations.png\n[file:run-logs.png]: .\u002F.github\u002Freadme\u002Frun-logs.png\n[file:settings-secrets.png]: .\u002F.github\u002Freadme\u002Fsettings-secrets.png\n[file:settings.gradle.kts]: .\u002Fsettings.gradle.kts\n[file:template_cleanup.yml]: .\u002F.github\u002Fworkflows\u002Ftemplate-cleanup.yml\n[file:use-this-template.png]: .\u002F.github\u002Freadme\u002Fuse-this-template.png\n\n[gh:actions]: https:\u002F\u002Fdocs.github.com\u002Factions\n[gh:build]: https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-platform-plugin-template\u002Factions?query=workflow%3ABuild\n[gh:code-samples]: https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-sdk-code-samples\n[gh:dependabot]: https:\u002F\u002Fdocs.github.com\u002Fen\u002Fcode-security\u002Fdependabot\u002Fdependabot-version-updates\n[gh:dependabot-pr]: https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-platform-plugin-template\u002Fpull\u002F73\n[gh:dependabot-supported-ecosystems]: https:\u002F\u002Fdocs.github.com\u002Fen\u002Fcode-security\u002Fdependabot\u002Fecosystems-supported-by-dependabot\u002Fsupported-ecosystems-and-repositories#gradle\n[gh:gradle-changelog-plugin]: https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fgradle-changelog-plugin\n[gh:intellij-platform-gradle-plugin]: https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-platform-gradle-plugin\n[gh:intellij-platform-gradle-plugin-docs]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Ftools-intellij-platform-gradle-plugin.html\n[gh:intellij-platform-gradle-plugin-runIde]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Ftools-intellij-platform-gradle-plugin-tasks.html#runIde\n[gh:intellij-platform-gradle-plugin-verifyPlugin]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fintellij\u002Ftools-intellij-platform-gradle-plugin-tasks.html#verifyPlugin\n[gh:releases]: https:\u002F\u002Fgithub.com\u002FJetBrains\u002Fintellij-platform-plugin-template\u002Freleases\n\n[gradle]: https:\u002F\u002Fgradle.org\n[gradle:build-cache]: https:\u002F\u002Fdocs.gradle.org\u002Fcurrent\u002Fuserguide\u002Fbuild_cache.html\n[gradle:configuration-cache]: https:\u002F\u002Fdocs.gradle.org\u002Fcurrent\u002Fuserguide\u002Fconfiguration_cache.html\n[gradle:kotlin-dsl]: https:\u002F\u002Fdocs.gradle.org\u002Fcurrent\u002Fuserguide\u002Fkotlin_dsl.html\n[gradle:lifecycle-tasks]: https:\u002F\u002Fdocs.gradle.org\u002Fcurrent\u002Fuserguide\u002Fjava_plugin.html#lifecycle_tasks\n[gradle:releases]: https:\u002F\u002Fgradle.org\u002Freleases\n\n[jb:github]: https:\u002F\u002Fgithub.com\u002FJetBrains\u002F.github\u002Fblob\u002Fmain\u002Fprofile\u002FREADME.md\n[jb:download-ij]: https:\u002F\u002Fwww.jetbrains.com\u002Fidea\u002Fdownload\n[jb:forum]: https:\u002F\u002Fintellij-support.jetbrains.com\u002Fhc\u002Fen-us\u002Fcommunity\u002Ftopics\u002F200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development\n[jb:ipe]: https:\u002F\u002Fjb.gg\u002Fipe\n[jb:my-tokens]: https:\u002F\u002Fplugins.jetbrains.com\u002Fauthor\u002Fme\u002Ftokens\n[jb:paid-plugins]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fmarketplace\u002Fpaid-plugins-marketplace.html\n[jb:quality-guidelines]: https:\u002F\u002Fplugins.jetbrains.com\u002Fdocs\u002Fmarketplace\u002Fquality-guidelines.html\n[jb:slack]: https:\u002F\u002Fplugins.jetbrains.com\u002Fslack\n[jb:twitter]: https:\u002F\u002Ftwitter.com\u002FJBPlatform\n[jb:ui-guidelines]: https:\u002F\u002Fjetbrains.github.io\u002Fui\n\n[github-actions-skip-ci]: https:\u002F\u002Fgithub.blog\u002Fchangelog\u002F2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci\u002F\n[keep-a-changelog]: https:\u002F\u002Fkeepachangelog.com\n[keep-a-changelog-how]: https:\u002F\u002Fkeepachangelog.com\u002Fen\u002F1.0.0\u002F#how\n[semver]: https:\u002F\u002Fsemver.org\n","IntelliJ Platform Plugin Template 是一个用于创建 IntelliJ 平台插件的模板仓库。它使用 Kotlin 语言，预配置了项目脚手架和持续集成环境，链接了相关文档，并保持了良好的组织结构，旨在简化插件开发的初始设置阶段。该模板包含了 Gradle 配置、插件模板结构、插件配置文件以及示例代码等关键元素，同时支持功能测试与 UI 测试，通过 GitHub Actions 实现持续集成，还提供了依赖管理、变更日志维护、发布流程及插件签名等功能。适用于希望快速启动 IntelliJ IDEA 或其他 JetBrains 产品插件开发工作的开发者。","2026-06-11 03:11:48","top_language"]