OXYGENHUB

chore(): add template files 7dbbbe7b7b24

Author
Andy McCall @andymccall <[email protected]>
When
· 2026-10-29 18:40 UTC
Signature
✔ signed by Andy McCall
Hash
7dbbbe7b7b24367bebdc2948ed72ff3ef53b26ccc8e110e3503721007d309935
Depends on
be9cad9ef885
Depended on by
nothing yet
In bookmarks
main
Edits
22 atoms, 43 tree operations, 21 files

Browse the tree at this change

added .oxyignore +6 −0
1 +
.DS_Store
2 +
.gradle
3 +
.idea
4 +
.intellijPlatform
5 +
.kotlin
6 +
build
added CHANGELOG.md +1025 −0
1 +
<!-- Keep a Changelog guide -> https://keepachangelog.com -->
2 +
3 +
# IntelliJ Platform Plugin Template Changelog
4 +
5 +
## [Unreleased]
6 +
7 +
### Changed
8 +
9 +
- GitHub Actions - migrate the deprecated `jlumbroso/free-disk-space` input to `preinstalled-runtimes`
10 +
- Dependencies - upgrade IntelliJ IDEA to `2026.2.3` (minimum platform `262`, Java `25`)
11 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.4.21`
12 +
- Upgrade Gradle Wrapper to `9.8.1`
13 +
- Update `intellijIdea` to `2025.3.6.1`
14 +
- Dependencies (GitHub Actions) - upgrade `ad-m/github-push-action` to `v1.3.0`
15 +
- Dependencies (GitHub Actions) - upgrade `jlumbroso/free-disk-space` to `v2.0.0`
16 +
- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `v6`
17 +
- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v7`
18 +
- Dependencies - upgrade IntelliJ IDEA to `2025.2.6.3`
19 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.4.20`
20 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.19.0`
21 +
- Upgrade Gradle Wrapper to `9.8.0`
22 +
23 +
## [2.6.0] - 2026-05-04
24 +
25 +
### Added
26 +
27 +
- Add operator function for resource bundle key access in `MyBundle`
28 +
29 +
### Changed
30 +
31 +
- Upgrade Gradle Wrapper to `9.5.0`
32 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.16.0`
33 +
- Dependencies - upgrade IntelliJ IDEA to `2025.2.6.2`
34 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v7`
35 +
- Dependencies (GitHub Actions) - upgrade `gradle/actions/setup-gradle` to `v6`
36 +
- GitHub Actions - simplify plugin artifact upload in GitHub Actions workflow
37 +
38 +
### Removed
39 +
40 +
- Remove changelog configuration from `build.gradle.kts` as it is preconfigured now in the IntelliJ Platform Gradle Plugin
41 +
- Remove `intellijPlatform.pluginConfiguration.description` default configuration from `build.gradle.kts`.
42 +
- Remove `run-ui-tests.yml` workflow for outdated UI testing setup
43 +
44 +
### Fixed
45 +
46 +
- Update Run Plugin configuration to fix sandbox log file path
47 +
- Remove `settings.gradle.kts` for cleanup of unused project configuration.
48 +
- Update Run Plugin configuration to fix sandbox log file path
49 +
50 +
## [2.5.0] - 2026-04-17
51 +
52 +
### Changed
53 +
54 +
- Migrate IntelliJ Platform repository configuration to `settings.gradle.kts`
55 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.14.0`
56 +
- Update `group` property in `gradle.properties` and remove redundant `pluginGroup` configuration from `build.gradle.kts`
57 +
- Update `version` property in `gradle.properties` and remove redundant `pluginVersion` configuration from `build.gradle.kts`
58 +
- Inline `junit` dependency version in `build.gradle.kts` and remove it from `libs.versions.toml`.
59 +
- Remove `platformVersion` property and inline its value in `build.gradle.kts` for cleaner configuration.
60 +
- Remove `libs.versions.toml` and inline plugin versions in build scripts for simpler configuration.
61 +
62 +
### Removed
63 +
64 +
- Remove (empty) plugin and module dependency configurations from `build.gradle.kts` and `gradle.properties`.
65 +
- Remove `opentest4j` dependency from `build.gradle.kts` and `libs.versions.toml`, redundant  since IntelliJ Platform 251+
66 +
- Remove `gradleVersion` property and wrapper configuration as Gradle Wrapper should be updated with `./gradlew wrapper --gradle-version=9.4.1 && ./gradlew wrapper`
67 +
- Remove Qodana configuration, dependencies, and related workflow steps.
68 +
- Remove Kover configuration, dependencies, and related workflow steps.
69 +
- Remove redundant Kotlin JVM toolchain configuration from `build.gradle.kts`
70 +
- Remove redundant `intellijPlatform.pluginConfiguration.ideaVersion.sinceBuild` configuration from `build.gradle.kts`
71 +
- Remove redundant `pluginSinceBuild` property from `gradle.properties`
72 +
- Remove redundant `intellijPlatform.signing` configuration from `build.gradle.kts`
73 +
- Remove redundant `intellijPlatform.publishing.token` configuration from `build.gradle.kts`
74 +
- Remove redundant `intellijPlatform.pluginVerification` configuration from `build.gradle.kts`
75 +
- Remove redundant `java` plugin declaration from `build.gradle.kts`
76 +
- Remove `pluginVersion` configuration from `build.gradle.kts`.
77 +
- Remove `pluginName` property from `gradle.properties` and `build.gradle.kts` as it is already set in the `plugin.xml`
78 +
- Remove `intellijPlatform.publishing.channels` configuration from `build.gradle.kts`.
79 +
- Remove `runIdeForUiTests` obsolete task from `build.gradle.kts`.
80 +
81 +
## [2.4.1] - 2026-03-20
82 +
83 +
### Fixed
84 +
85 +
- GitHub Actions: handle empty releases list in draft cleanup step using `xargs -r`
86 +
87 +
### Changed
88 +
89 +
- Upgrade Gradle Wrapper to `9.4.1`
90 +
- Set empty `versionPrefix` for changelog in Gradle build file.
91 +
- Update `platformVersion` to `2025.2.6.1`
92 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.13.1`
93 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.3.20`
94 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2025.3.2`
95 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.9.7`
96 +
- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v6`
97 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v6`
98 +
- GitHub Actions: Setup Java and Gradle actions for the `releaseDraft` build step
99 +
100 +
## [2.4.0] - 2025-11-25
101 +
102 +
### Fixed
103 +
104 +
- Use the GitHub event release body for a condition when creating the Release Draft
105 +
106 +
### Changed
107 +
108 +
- Use `intellijIdea(version)` dependency helper instead of `create(type,  version)`
109 +
- Upgrade Gradle Wrapper to `9.2.1`
110 +
- Update `platformVersion` to `2025.2.5`
111 +
- Change since build to `252` (2025.2)
112 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.10.5`
113 +
- Dependencies - upgrade `org.jetbrains.changelog` to `2.5.0`
114 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.2.21`
115 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.9.3`
116 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2025.2.2`
117 +
- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v5`
118 +
- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `v5`
119 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v5`
120 +
- Dependencies (GitHub Actions) - upgrade `gradle/actions/setup-gradle` to `v5`
121 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2025.2.2`
122 +
123 +
### Removed
124 +
125 +
- Remove the `platformType` Gradle property
126 +
127 +
## [2.3.1] - 2025-08-09
128 +
129 +
### Added
130 +
131 +
- Add `platformBundledModules` to `gradle.properties` along with `bundledModules()` helper to the Gradle build file
132 +
133 +
### Changed
134 +
135 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.7.1`
136 +
137 +
### Fixed
138 +
139 +
- GitHub: Fixed the missing `$RELEASE_NOTE ` parent directory in the Release workflow
140 +
141 +
## [2.3.0] - 2025-08-09
142 +
143 +
### Added
144 +
145 +
- Added `.DS_Store` directory to `.gitignore`
146 +
147 +
### Changed
148 +
149 +
- GitHub Actions: simplify changelog handling
150 +
- Dependencies - upgrade `org.jetbrains.changelog` to `2.4.0`
151 +
152 +
## [2.2.0] - 2025-08-05
153 +
154 +
### Added
155 +
156 +
- GitHub Actions: set Gradle cache to read-only for non-build jobs
157 +
- GitHub Actions: add `jlumbroso/free-disk-space` action to build related steps to maximize build environment storage
158 +
- Added `.kotlin` directory to `.gitignore` for Kotlin 2.0
159 +
160 +
### Removed
161 +
162 +
- Remove `pluginUntilBuild` obsolete property
163 +
- GitHub Actions: Remove obsolete Plugin Verifier cache directory configuration 
164 +
165 +
### Changed
166 +
167 +
- Upgrade Gradle Wrapper to `8.14.3`
168 +
- Update `platformVersion` to `2024.3.6`
169 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.7.0`
170 +
- Dependencies - upgrade `org.jetbrains.changelog` to `2.3.0`
171 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2025.1.1`
172 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.2.0`
173 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2025.1.1`
174 +
- Dependencies (GitHub Actions) - upgrade `ad-m/github-push-action` to `v0.8.0`
175 +
- Dependencies (GitHub Actions) - upgrade `jlumbroso/free-disk-space` to `v1.3.1`
176 +
- Gradle - upgrade `org.gradle.toolchains.foojay-resolver-convention` to `1.0.0`
177 +
- Change since build to `243` (2024.3)
178 +
- Update codecov configuration based on new required upload token
179 +
180 +
## [2.1.0] - 2025-03-28
181 +
182 +
### Added
183 +
184 +
- Example code – `ProjectActivity`
185 +
- Added `opentest4j` test dependency, see: [Missing opentest4j dependency in Test Framework](https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-faq.html#missing-opentest4j-dependency-in-test-framework)
186 +
187 +
### Removed
188 +
189 +
- Example code – `MyApplicationActivationListener`
190 +
- Remove redundant IntelliJ Platform dependency helpers: `instrumentationTools()`, `pluginVerifier()`, `zipSigner()`
191 +
- GitHub Actions: Remove `gradle/actions/wrapper-validation` because validation is performed by default in `gradle/actions/setup-gradle@v4`
192 +
193 +
### Changed
194 +
195 +
- Change JVM version to `21`
196 +
- Upgrade Gradle Wrapper to `8.13`
197 +
- Update `platformVersion` to `2024.2.5`
198 +
- Change since/until build to `242-252.*` (2024.2-2025.2.*)
199 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.5.0`
200 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.1.20`
201 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2024.3.4`
202 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.9.1`
203 +
- Dependencies (GitHub Actions) - upgrade `gradle/actions/wrapper-validation` to `v4`
204 +
- Dependencies (GitHub Actions) - upgrade `codecov/codecov-action` to `v5`
205 +
206 +
## [2.0.2] - 2024-10-07
207 +
208 +
### Changed
209 +
210 +
- Upgrade Gradle Wrapper to `8.10.2`
211 +
- Update `platformVersion` to `2023.3.8`
212 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.1.0`
213 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2024.2.3`
214 +
- Dependencies (GitHub Actions) - upgrade `gradle/actions/setup-gradle` to `v4`
215 +
- Add back the `org.gradle.toolchains.foojay-resolver-convention` Gradle settings plugin
216 +
217 +
### Fixed
218 +
219 +
- Fixed _Run Plugin_ run configuration logs location
220 +
221 +
### Removed
222 +
223 +
- Removed _Run Qodana_ and _Run UI for UI Tests_ run configurations
224 +
225 +
## [2.0.1] - 2024-08-09
226 +
227 +
### Changed
228 +
229 +
- Update `platformVersion` to `2023.3.7`
230 +
- Change since/until build to `233-242.*` (2023.3-2024.2.*)
231 +
- Cleanup registering the `runIdeForUiTests` task
232 +
- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.0.1`
233 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.25`
234 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.8.3`
235 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2024.1.9`
236 +
237 +
## [2.0.0] - 2024-07-30
238 +
239 +
### Changed
240 +
241 +
- Migrate to [IntelliJ Platform Gradle Plugin 2.0](https://blog.jetbrains.com/platform/2024/07/intellij-platform-gradle-plugin-2-0/).
242 +
243 +
## [1.14.2] - 2024-07-12
244 +
245 +
### Changed
246 +
247 +
- Upgrade Gradle Wrapper to `8.9`
248 +
249 +
### Removed
250 +
251 +
- Remove default plugin icon (`pluginIcon.svg`)
252 +
253 +
## [1.14.1] - 2024-06-19
254 +
255 +
### Changed
256 +
257 +
- Update `platformVersion` to `2023.2.7`
258 +
- Upgrade Gradle Wrapper to `8.8`
259 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.17.4`
260 +
- Dependencies - downgrade `org.jetbrains.kotlin.jvm` to `1.9.24`
261 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.8.1`
262 +
263 +
## [1.14.0] - 2024-05-30
264 +
265 +
### Changed
266 +
267 +
- Update `platformVersion` to `2023.2.6`
268 +
- Change since/until build to `232-242.*` (2023.2-2024.2.*)
269 +
- Upgrade Gradle Wrapper to `8.7`
270 +
- Update Kover configuration
271 +
- Replace `org.jetbrains:annotations` library with an `com.example:exampleLibrary` placeholder
272 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.17.3`
273 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.0.0`
274 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.8.0`
275 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2024.1.5`
276 +
- Dependencies (GitHub Actions) - replace `gradle/wrapper-validation-action@v2` with `gradle/actions/wrapper-validation@v3`
277 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2024.1.5`
278 +
- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `v4`
279 +
280 +
## [1.13.0] - 2024-03-11
281 +
282 +
### Changed
283 +
284 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.23`
285 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.6`
286 +
- Dependencies - upgrade `org.jetbrains.qodana` to `2023.3.2`
287 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `4`
288 +
- Dependencies (GitHub Actions) - upgrade `codecov/codecov-action` to `4`
289 +
- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `2`
290 +
- Dependencies (GitHub Actions) - upgrade `actions/cache` to `4`
291 +
- Gradle - upgrade `org.gradle.toolchains.foojay-resolver-convention` to `0.8.0`
292 +
- Gradle - cleanup the `jvmToolchain` setup
293 +
- Run Configurations - `Run Qodana` runs the `qodanaScan` Gradle task
294 +
295 +
### Fixed
296 +
297 +
- Fixed calculation of the plugin publication channel
298 +
- Run Configurations - `Run Tests` uses the `RunAsTest` IDE feature
299 +
- Replace the whole `IntelliJ Platform Plugin Template` with the new project name when running the GitHub Actions Cleanup workflow
300 +
301 +
### Removed
302 +
303 +
- GitHub Actions: Remove the `Setup Java` step from the `releaseDraft` build step
304 +
- Gradle - Removed Qodana Gradle Plugin configuration to rely on defaults
305 +
306 +
## [1.12.0] - 2024-02-20
307 +
308 +
### Added
309 +
310 +
- GitHub Actions: Reduce the number of concurrent builds
311 +
312 +
### Changed
313 +
314 +
- Change since/until build to `223-241.*` (2022.3-2024.1.*)
315 +
- Upgrade Gradle Wrapper to `8.6`
316 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.17.2`
317 +
- Dependencies (GitHub Actions) - upgrade `gradle/gradle-build-action@v2` to `gradle/actions/setup-gradle@v3`
318 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.3.1`
319 +
320 +
### Fixed
321 +
322 +
- Adjusted obtaining the value for `publishPlugin.channels` property in `build.gradle.kts`
323 +
- Fixed bash variable access in the Create Release Draft step.
324 +
325 +
### Removed
326 +
327 +
- Remove Gradle Kotlin DSL Lazy Property Assignment because it's default now
328 +
329 +
## [1.11.3] - 2023-12-01
330 +
331 +
### Changed
332 +
333 +
- Upgrade Gradle Wrapper to `8.5`
334 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.16.1`
335 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.21`
336 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.5`
337 +
- Dependencies - upgrade `annotations` to `24.1.0`
338 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.8`
339 +
- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `4`
340 +
341 +
## [1.11.2] - 2023-10-06
342 +
343 +
### Changed
344 +
345 +
- Upgrade Gradle Wrapper to `8.4`
346 +
- Gradle - use JetBrains Runtime
347 +
- Gradle - upgrade `org.gradle.toolchains.foojay-resolver-convention` to `0.7.0`
348 +
- Change since/until build to `223-233.*` (2022.3-2023.3.*)
349 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.16.0`
350 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.10`
351 +
- Dependencies - upgrade `org.jetbrains.changelog` to `2.2.0`
352 +
- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `4`
353 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.6`
354 +
355 +
## [1.11.1] - 2023-08-17
356 +
357 +
### Fixed
358 +
359 +
- GitHub Actions: publish workflow fails due to the existing `release changelog` label
360 +
361 +
### Changed
362 +
363 +
- Upgrade Gradle Wrapper to `8.3`
364 +
365 +
## [1.11.0] - 2023-08-07
366 +
367 +
### Changed
368 +
369 +
- GitHub Actions: move the `Maximize Build Space` step from the `Build` job to `Inspect code` and `Verify plugin` jobs
370 +
- Update `platformVersion` to `2022.3.3`
371 +
- Change since/until build to `223-232.*` (2022.3-2023.2.*)
372 +
- `MyBundle`: remove `SpreadOperator` suppression
373 +
- `MyBundle.properties`: remove unused `name` property
374 +
375 +
## [1.10.0] - 2023-08-04
376 +
377 +
### Added
378 +
379 +
- [Foojay Toolchains Plugin](https://github.com/gradle/foojay-toolchains) integration
380 +
- GitHub Actions: set `gradle-home-cache-cleanup: true` flag to the Gradle Build Action
381 +
- GitHub Actions: use `jlumbroso/free-disk-space` to free disk space
382 +
383 +
### Changed
384 +
385 +
- GitHub Actions: rearrange the Build workflow
386 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.3`
387 +
- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.1.0`
388 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.1`
389 +
390 +
### Fixed
391 +
392 +
- GitHub Actions: Fixed Kover report path when uploading the code coverage report
393 +
394 +
## [1.9.0] - 2023-07-11
395 +
396 +
### Added
397 +
398 +
- GitHub Actions — use Java `17` explicitly
399 +
400 +
### Changed
401 +
402 +
- Upgrade Gradle Wrapper to `8.2.1`
403 +
- Dependencies — upgrade `org.jetbrains.changelog` to `2.1.2`
404 +
- GitHub Actions — rearrange the Build workflow
405 +
406 +
### Fixed
407 +
408 +
- Fixed copying files issue when running the `Template Cleanup` workflow
409 +
410 +
## [1.8.0] - 2023-07-07
411 +
412 +
### Changed
413 +
414 +
- GitHub Actions: Build workflow refactoring
415 +
- Upgrade Gradle Wrapper to `8.2`
416 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.0`
417 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.15.0`
418 +
- Dependencies - upgrade `org.jetbrains.changelog` to `2.1.1`
419 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.2`
420 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.1.5`
421 +
422 +
### Fixed
423 +
424 +
- Dependabot workflow points to `next` branch in a newly created project
425 +
426 +
### Removed
427 +
428 +
- Removed workaround for Kotlin Compiler `OutOfMemoryError` as the issue is gone with Kotlin `1.9.0`
429 +
430 +
## [1.7.0] - 2023-06-07
431 +
432 +
### Added
433 +
434 +
- GitHub Actions — enable caching
435 +
- Specify `projectJDK: 17` in `qodana.yml`
436 +
- Specify `linter` property in `qodana.yml`
437 +
438 +
### Changed
439 +
440 +
- Use Java `17` for JVM Toolchain
441 +
- Change since/until build to `222-232.*` (2022.2–2023.2.*)
442 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.14.1`
443 +
- Dependencies - upgrade `org.jetbrains.changelog` to `2.1.0`
444 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.21`
445 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.1`
446 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.1.0`
447 +
- Upgrade Gradle Wrapper to `8.1.1`
448 +
- GitHub Actions — switch to Java 17
449 +
- Update Run Configuration entries
450 +
- Adjust Kover configuration
451 +
452 +
### Fixed
453 +
454 +
- Example code — Fixed deprecated usage of `ContentFactory` in `MyToolWindowFactory`
455 +
- Example code — Migrate from the deprecated `FrameStateListener.onFrameActivated()` to `ApplicationActivationListener.applicationActivated(IdeFrame)`
456 +
457 +
### Removed
458 +
459 +
- Remove `gradleJvm` property from the `.idea/gradle.xml` file
460 +
- GitHub Actions — Drop unused `name` output from the `Build` workflow
461 +
462 +
## [1.6.0] - 2023-04-13
463 +
464 +
### Added
465 +
466 +
- Temporary workaround for Kotlin Compiler `OutOfMemoryError` -> https://jb.gg/intellij-platform-kotlin-oom
467 +
- Gradle version catalog integration
468 +
- Gradle Kotlin DSL Lazy Property Assignment
469 +
- Enable Gradle Build Cache
470 +
471 +
### Changed
472 +
473 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.13.3`
474 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.20`
475 +
- Upgrade Gradle Wrapper to `8.1`
476 +
- Remove `UnusedProperty` suppression in `gradle.properties` file
477 +
- Rename `org.gradle.unsafe.configuration-cache` to `org.gradle.configuration-cache` in `gradle.properties`
478 +
479 +
## [1.5.0] - 2023-03-10
480 +
481 +
### Added
482 +
483 +
- Migrate to Gradle Provider API improving configuration cache compatibility
484 +
- Example code - `FrameStateListener` application listener
485 +
- Example code - `MyToolWindowFactory` tool window basic implementation
486 +
487 +
### Changed
488 +
489 +
- Update `platformVersion` to `2022.1.4`
490 +
- Change since/until build to `221-231.*` (2022.1-2023.1.*)
491 +
- Example code - registered project service changed into a lightweight one
492 +
- GitHub Actions — pass changelog release notes as a multi-line content
493 +
- GitHub Actions — provide `plugin.verifier.home.dir` variable as a system property instead of project property
494 +
- Template Cleanup: remove default `pluginIcon.svg` icon
495 +
- Upgrade Gradle Wrapper to `8.0.2`
496 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.10`
497 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.13.2`
498 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.3.4`
499 +
- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.0.6`
500 +
501 +
### Fixed
502 +
503 +
- Resolving the content for the `patchPluginXML.changeNotes` property
504 +
505 +
### Removed
506 +
507 +
- Example code — application service
508 +
- Example code — deprecated `ProjectManagerListener` application listener
509 +
510 +
## [1.4.0] - 2023-01-13
511 +
512 +
### Changed
513 +
514 +
- GitHub Actions — use `GITHUB_OUTPUT` environment file instead of `::set-output`.
515 +
- Upgrade Gradle Wrapper to `7.6`
516 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.0`
517 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.12.0`
518 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.3.0`
519 +
520 +
### Fixed
521 +
522 +
- Fallback to the unreleased change notes when the plugin in current was not released yet
523 +
524 +
## [1.3.0] - 2022-11-17
525 +
526 +
### Added
527 +
528 +
- [Kover](https://github.com/Kotlin/kotlinx-kover) integration
529 +
- Enable [Gradle Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html) in `gradle.properties`
530 +
- GitHub Actions — mark the pull request created with _Publish Plugin_ workflow with `release changelog` label
531 +
- GitHub Actions — send code coverage reports to [CodeCov](https://codecov.io)
532 +
- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.6.1`
533 +
534 +
### Changed
535 +
536 +
- Update `changelog` extension configuration in `build.gradle.kts` file
537 +
- Update `pluginUntilBuild` to include `223.*` (2022.3.*)
538 +
- Use `kotlin.jvmToolchain(11)` shorthand in Gradle configuration
539 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.10.0`
540 +
- Dependencies - upgrade `org.jetbrains.changelog` to `2.0.0`
541 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.7.21`
542 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.2.3`
543 +
- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.0.5`
544 +
- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `v3`
545 +
- Use `file` instead of `projectDir.resolve` in Gradle configuration file
546 +
547 +
### Fixed
548 +
549 +
- Update broken link in `gradle.properties`
550 +
- GitHub Actions — use `$BRANCH` for creating changelog pull request
551 +
552 +
## [1.2.0] - 2022-08-07
553 +
554 +
### Added
555 +
556 +
- Use JVM toolchain for configuring source/target compilation compatibility
557 +
- Make sure GitHub Actions release jobs have write permissions
558 +
- Example implementation: Add `TODO()` with a hint to remove stale sample code
559 +
- Exclude `.qodana` directory from Qodana analysis
560 +
- Maximize disk space on GitHub Actions
561 +
562 +
### Changed
563 +
564 +
- Upgrade Gradle Wrapper to `7.5.1`
565 +
- Update `platformVersion` to `2021.3.3`
566 +
- Change since/until build to `213-222.*` (2021.3-2022.2)
567 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.8.0`
568 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.7.10`
569 +
- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `3`
570 +
- Dependencies (GitHub Actions) - upgrade `actions/cache` to `3`
571 +
- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `3`
572 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `3`
573 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.2.1`
574 +
575 +
### Fixed
576 +
577 +
- Pass Plugin Signing secrets as environment variables in the Release workflow
578 +
579 +
### Removed
580 +
581 +
- Removed Gradle caching from GitHub Actions
582 +
583 +
## [1.1.2] - 2022-02-11
584 +
585 +
### Changed
586 +
587 +
- Update `platformVersion` to `2021.1.3` for compatibility with Apple M1
588 +
- Change since/until build to `211-213.*` (2021.1-2021.3)
589 +
- Upgrade Gradle Wrapper to `7.4`
590 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.4.0`
591 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `4.2.5`
592 +
593 +
## [1.1.1] - 2022-01-24
594 +
595 +
### Changed
596 +
597 +
- GitHub Actions — fixed duplicated `.zip` extension in artifact file's name of the build flow
598 +
- Upgrade Gradle Wrapper to `7.3.3`
599 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.3.1`
600 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.6.10`
601 +
- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `4.2.3`
602 +
- Dependencies (GitHub Actions) - upgrade `actions/cache` to `2.1.7`
603 +
604 +
## [1.1.0] - 2021-11-16
605 +
606 +
### Added
607 +
608 +
- GitHub Actions: Collect Qodana/Tests/Plugin Verifier results as artifacts
609 +
610 +
### Changed
611 +
612 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.3.0`
613 +
- Dependencies - upgrade `org.jetbrains.changelog` to `1.3.1`
614 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.6.0`
615 +
- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `2`
616 +
- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `2.3.5`
617 +
- GitHub Actions general performance refactoring
618 +
- GitHub Actions — prepare plugin archive content to be archived at once
619 +
- GitHub Actions — patch changelog only if change notes are provided
620 +
- Update `pluginUntilBuild` to include `213.*` (2021.3.*)
621 +
- Upgrade Gradle Wrapper to `7.3`
622 +
623 +
### Fixed
624 +
625 +
- Fixed passing change notes from `CHANGELOG.md` to the Release Draft
626 +
- Fixed passing updated change notes from the Release Draft to `patchChangelog` Gradle task
627 +
- Fixed `QODANA_SHOW_REPORT` environment variable resolving for Gradle `6.x`
628 +
629 +
### Removed
630 +
631 +
- Removed the `pluginVerifierIdeVersions` configuration to use a default IDEs list provided by the `listProductsReleases` task for `runPluginVerifier`
632 +
- Removed `platformDownloadSources` from Gradle configuration to use default value
633 +
- Removed `updateSinceUntilBuild.set(true)` from Gradle configuration to use default value
634 +
635 +
## [1.0.0] - 2021-09-07
636 +
637 +
### Added
638 +
639 +
- Plugin Signing
640 +
- Qodana integration
641 +
- Functional tests
642 +
- Compatibility with Java 11
643 +
- `Run Qodana` and `Run IDE for UI Tests` run configurations
644 +
- Use Gradle `wrapper` task to handle Gradle updates
645 +
- JVM compatibility version extracted to `gradle.properties` file
646 +
- Suppress `UnusedProperty` inspection for the `kotlin.stdlib.default.dependency` in `gradle.properties`
647 +
648 +
### Changed
649 +
650 +
- GitHub Actions: Switch to Java 11
651 +
- GitHub Actions: Update Build and Release flows
652 +
- GitHub Actions: Use Gradle cache provided with `actions/setup-java`
653 +
- Update `pluginVerifierIdeVersions` to `2020.3.4, 2021.1.3, 2021.2.1`
654 +
- Change since/until build to `203-212.*`
655 +
- Upgrade Gradle Wrapper to `7.2`
656 +
- Gradle – Changelog plugin configuration update
657 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.5.30`
658 +
- Dependencies - upgrade `org.jetbrains.changelog` to `1.3.0`
659 +
- Dependencies - upgrade `org.jetbrains.intellij` to `1.1.6`
660 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v2.2.4`
661 +
662 +
### Fixed
663 +
664 +
- Use `DynamicBundle` instead of `AbstractBundle` in `MyBundle.kt`
665 +
666 +
### Removed
667 +
668 +
- Removed `detekt`/`ktlint` integration
669 +
670 +
## [0.10.1] - 2021-05-31
671 +
672 +
### Added
673 +
674 +
- Introduced `next` branch in the root repository to make `main` always a stable one
675 +
676 +
### Changed
677 +
678 +
- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.6`
679 +
- Trigger GitHub Actions `Build` workflows only on pushes to `main` branch or pull request to avoid duplicated checks
680 +
681 +
## [0.10.0] - 2021-05-27
682 +
683 +
### Changed
684 +
685 +
- Remove reference to the `jcenter()` from Gradle configuration file
686 +
- Update `pluginVerifierIdeVersions` to `2020.2.4, 2020.3.4, 2021.1.2`
687 +
- Update `pluginUntilBuild` to include `211.*` (2021.1.*)
688 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.5.10`
689 +
- Dependencies - upgrade `detekt-formatting from` to `1.17.1`
690 +
- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.17.1`
691 +
- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.5`
692 +
- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v2.3.4`
693 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-release-asset` to `v1.0.2`
694 +
- Dependencies (GitHub Actions) - upgrade `actions/create-release` to `v1.1.4`
695 +
- Upgrade Gradle Wrapper to `7.0.2`
696 +
697 +
## [0.9.0] - 2021-03-29
698 +
699 +
### Added
700 +
701 +
- `properties` shorthand function for accessing `gradle.properties` in a cleaner way
702 +
- Dependabot check for GitHub Actions used in [workflow files](.github/workflows)
703 +
704 +
### Changed
705 +
706 +
- Dependencies - upgrade `detekt-formatting from` to `1.16.0`
707 +
- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.16.0`
708 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.32`
709 +
- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v2.2.2`
710 +
- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.4`
711 +
712 +
### Fixed
713 +
714 +
- Fix `README.md` file resolution in the `build.gradle.kts`
715 +
716 +
## [0.8.3] - 2021-02-23
717 +
718 +
### Changed
719 +
720 +
- Dependencies - upgrade `org.jetbrains.intellij` to `0.7.2`
721 +
- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `10.0.0`
722 +
- Update `platformVersion` to `2020.2.4` for compatibility with macOS Big Sur
723 +
- Upgrade Gradle Wrapper to `6.8.3`
724 +
725 +
## [0.8.2] - 2021-02-09
726 +
727 +
### Changed
728 +
729 +
- Use `-bin` distribution of the Gradle Wrapper
730 +
- Upgrade Gradle Wrapper to `6.8.2`
731 +
- Update `pluginVerifierIdeVersions` in `gradle.properties` files
732 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.30`
733 +
- Dependencies - upgrade `org.jetbrains.changelog` to `1.1.1`
734 +
- Configure the `changelog` Gradle plugin
735 +
736 +
## [0.8.1] - 2021-01-12
737 +
738 +
### Added
739 +
740 +
- README: Dependencies management section
741 +
742 +
### Changed
743 +
744 +
- Upgrade Gradle Wrapper to `6.8`
745 +
- Dependencies - upgrade `org.jetbrains.changelog` to `1.0.0`
746 +
747 +
### Fixed
748 +
749 +
- Template Cleanup: Escape GitHub username to avoid incorrect characters in class package name
750 +
- Template Cleanup: Run `ktlintFormat` task to fix imports order
751 +
- GitHub Actions: Use the correct property in the "Upload artifact" step
752 +
753 +
## [0.8.0] - 2020-12-21
754 +
755 +
### Added
756 +
757 +
- Dependabot integration
758 +
- Show `idea.log` logs of the run IDE in the Run console
759 +
- README: FAQ section
760 +
761 +
### Changed
762 +
763 +
- `build.gradle.kts`: simpler syntax for configuring `KotlinCompile`
764 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.21`
765 +
- Dependencies - upgrade `detekt-formatting` to `1.15.0`
766 +
- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.15.0`
767 +
- README: Clarifying the Java usage in the project
768 +
- `pluginVerifierIdeVersions` - upgrade to `2020.1.4, 2020.2.3, 2020.3.1`
769 +
770 +
### Fixed
771 +
772 +
- Return `Supplier<@Nls String>` instead of `String` in `MyBundle.messagePointer`
773 +
774 +
## [0.7.1] - 2020-12-02
775 +
776 +
### Changed
777 +
778 +
- Upgrade Gradle Wrapper to `6.7.1`
779 +
- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.5`
780 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.20`
781 +
- Update the base platform version to 2020.1
782 +
- Change since/until build to `201-203.*`
783 +
784 +
## [0.7.0] - 2020-11-16
785 +
786 +
### Added
787 +
788 +
- Predefined Run/Debug Configurations
789 +
- Project icon for development purposes
790 +
791 +
### Changed
792 +
793 +
- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.3`
794 +
795 +
## [0.6.1] - 2020-11-05
796 +
797 +
### Added
798 +
799 +
- GitHub Actions — use hash based on `pluginVerifierIdeVersions` in `Setup Plugin Verifier IDEs Cache` step
800 +
801 +
### Changed
802 +
803 +
- Use [Kotlin extension function](https://plugins.jetbrains.com/docs/intellij/plugin-services.html#retrieving-a-service) to retrieve the `MyProjectService` in the `MyProjectManagerListener`
804 +
- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.2`
805 +
- Update `pluginVerifierIdeVersions` in the `gradle.properties` files
806 +
807 +
## [0.6.0] - 2020-10-29
808 +
809 +
### Added
810 +
811 +
- Integration with [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier) through the [Gradle IntelliJ Plugin](https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#runpluginverifier-task) `runPluginVerifier` task
812 +
- Cache downloaded IDEs used by Plugin Verifier for the verification
813 +
814 +
### Changed
815 +
816 +
- Switch Gradle Wrapper to `-all` to improve the IntelliSense
817 +
- Update detekt config to be in line with IJ settings
818 +
- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.14.2`
819 +
- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.1`
820 +
- GitHub Actions — `gradleValidation` update to `gradle/[email protected]`
821 +
- GitHub Actions — `releaseDraft` update to `actions/download-artifact@v2`
822 +
823 +
### Removed
824 +
825 +
- Remove Third-party IntelliJ Plugin Verifier GitHub Action
826 +
827 +
## [0.5.1] - 2020-10-15
828 +
829 +
### Added
830 +
831 +
- Missing properties in the `gradle.properties` template file
832 +
833 +
### Changed
834 +
835 +
- Upgrade Gradle Wrapper to `6.7`
836 +
- Dependencies - upgrade `org.jetbrains.changelog` to `0.6.2`
837 +
838 +
## [0.5.0] - 2020-10-12
839 +
840 +
### Added
841 +
842 +
- Introduced `platformPlugins` property in `gradle.properties` for configuring dependencies to bundled/external plugins
843 +
844 +
### Changed
845 +
846 +
- Disable "Release Draft" job for pull requests in the "Build" GitHub Actions Workflow
847 +
- Dependencies - upgrade `org.jetbrains.intellij` to `0.5.0`
848 +
- Dependencies - upgrade `org.jetbrains.changelog` to `0.6.1`
849 +
- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.14.1`
850 +
- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `9.4.1`
851 +
- Remove LICENSE file during the Template Cleanup workflow
852 +
853 +
## [0.4.0] - 2020-10-02
854 +
855 +
### Added
856 +
857 +
- Fix default to opt-out of bundling Kotlin standard library in plugin distribution
858 +
859 +
### Changed
860 +
861 +
- GitHub Actions: allow releasing plugin even for the base project
862 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.10`
863 +
- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.13.1`
864 +
865 +
### Fixed
866 +
867 +
- `pluginName` variable name collision with `intellij` closure getter in Gradle configuration #29
868 +
869 +
## [0.3.2] - 2020-08-09
870 +
871 +
### Changed
872 +
873 +
- Simplify and optimize GitHub Actions
874 +
- Gradle Wrapper upgrade to `6.6.1`
875 +
- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.0`
876 +
- Dependencies - upgrade `org.jetbrains.intellij` to `0.4.22`
877 +
- Dependencies - upgrade `org.jetbrains.changelog` to `0.5.0`
878 +
- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.12.0`
879 +
- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `9.4.0`
880 +
- Rename `master` branch to `main`
881 +
882 +
### Fixed
883 +
884 +
- GitHub Actions — cache Gradle dependencies and wrapper separately
885 +
886 +
## [0.3.1] - 2020-07-31
887 +
888 +
### Added
889 +
890 +
- Better handling of the Gradle plugin description extraction from the README file
891 +
- GitHub Actions — cache Gradle Wrapper
892 +
893 +
### Changed
894 +
895 +
- Gradle - remove kotlin("stdlib-jdk8") dependency to decrease the plugin artifact size
896 +
- Dependencies - bump ktlint to `9.3.0`
897 +
- GitHub Actions — make *Update Changelog* job dependent on the *Publish Plugin*
898 +
- GitHub Actions — run plugin verifier against `2019.3` `2020.1` `2020.2`
899 +
900 +
### Fixed
901 +
902 +
- Resolve ktlint reports
903 +
- GitHub Actions — Plugin Verifier broken for artifacts with spaces in name
904 +
905 +
## [0.3.0] - 2020-07-07
906 +
907 +
### Added
908 +
909 +
- Set the publishing channel depending on the plugin version, i.e. `1.0.0-beta` -> `beta` channel
910 +
911 +
### Changed
912 +
913 +
- Update `org.jetbrains.changelog` dependency to `v0.3.3`
914 +
- Update Gradle Wrapper to `v6.5.1`
915 +
- Run GitHub Actions Release workflow on `prereleased` event
916 +
- GitHub Actions — Release, separate changelog-related job from the release
917 +
918 +
### Fixed
919 +
920 +
- Remove vendor website from `plugin.xml`
921 +
- Update Template Cleanup workflow test to avoid running it on forks
922 +
923 +
## [0.2.0] - 2020-07-02
924 +
925 +
### Added
926 +
927 +
- JetBrains Plugin badges and TODO list for the end users
928 +
- `ktlint` integration
929 +
930 +
### Changed
931 +
932 +
- `pluginUntilBuild` set to the correct format: `201.*`
933 +
- Bump detekt dependency to `1.10.0`
934 +
935 +
### Fixed
936 +
937 +
- GitHub Actions — Template Cleanup, fixed adding files to git
938 +
- Update Template plugin name on cleanup
939 +
- Set `buildUponDefaultConfig = true` in detekt configuration
940 +
941 +
## [0.1.0] - 2020-06-26
942 +
943 +
### Added
944 +
945 +
- `settings.gradle.kts` for the [performance purposes](https://docs.gradle.org/current/userguide/organizing_gradle_projects.html#always_define_a_settings_file)
946 +
- `#REMOVE-ON-CLEANUP#` token to mark content to be removed with **Template Cleanup** workflow
947 +
948 +
### Changed
949 +
950 +
- README proofreading
951 +
- GitHub Actions — Update IDE versions for the Plugin Verifier
952 +
- Update platformVersion to `2020.1.2`
953 +
954 +
## [0.0.2] - 2020-06-22
955 +
956 +
### Added
957 +
958 +
- [Gradle Changelog Plugin](https://github.com/JetBrains/gradle-changelog-plugin) integration
959 +
960 +
### Changed
961 +
962 +
- Bump Detekt version
963 +
- Change pluginSinceBuild to 193
964 +
965 +
## [0.0.1]
966 +
967 +
### Added
968 +
969 +
- Initial project scaffold
970 +
- GitHub Actions to automate testing and deployment
971 +
- Kotlin support
972 +
973 +
[Unreleased]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.4.1...HEAD
974 +
[2.4.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.4.0...2.4.1
975 +
[2.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.3.1...2.4.0
976 +
[2.3.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.3.0...2.3.1
977 +
[2.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.2.0...2.3.0
978 +
[2.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.1.0...2.2.0
979 +
[2.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.0.2...2.1.0
980 +
[2.0.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.0.1...2.0.2
981 +
[2.0.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.0.0...2.0.1
982 +
[2.0.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.14.2...2.0.0
983 +
[1.14.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.14.1...1.14.2
984 +
[1.14.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.14.0...1.14.1
985 +
[1.14.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.13.0...1.14.0
986 +
[1.13.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.12.0...1.13.0
987 +
[1.12.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.3...1.12.0
988 +
[1.11.3]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.2...1.11.3
989 +
[1.11.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.1...1.11.2
990 +
[1.11.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.0...1.11.1
991 +
[1.11.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.10.0...1.11.0
992 +
[1.10.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.9.0...1.10.0
993 +
[1.9.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.8.0...1.9.0
994 +
[1.8.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.7.0...1.8.0
995 +
[1.7.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.6.0...1.7.0
996 +
[1.6.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.5.0...1.6.0
997 +
[1.5.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.4.0...1.5.0
998 +
[1.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.3.0...1.4.0
999 +
[1.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.2.0...1.3.0
1000 +
[1.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.1.2...1.2.0
1001 +
[1.1.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.1.1...1.1.2
1002 +
[1.1.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.1.0...1.1.1
1003 +
[1.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.0.0...1.1.0
1004 +
[1.0.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.10.1...1.0.0
1005 +
[0.10.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.10.0...0.10.1
1006 +
[0.10.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.9.0...0.10.0
1007 +
[0.9.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.3...0.9.0
1008 +
[0.8.3]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.2...0.8.3
1009 +
[0.8.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.1...0.8.2
1010 +
[0.8.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.0...0.8.1
1011 +
[0.8.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.7.1...0.8.0
1012 +
[0.7.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.7.0...0.7.1
1013 +
[0.7.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.6.1...0.7.0
1014 +
[0.6.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.6.0...0.6.1
1015 +
[0.6.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.5.1...0.6.0
1016 +
[0.5.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.5.0...0.5.1
1017 +
[0.5.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.4.0...0.5.0
1018 +
[0.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.3.2...0.4.0
1019 +
[0.3.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.3.1...0.3.2
1020 +
[0.3.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.3.0...0.3.1
1021 +
[0.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.2.0...0.3.0
1022 +
[0.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.1.0...0.2.0
1023 +
[0.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.0.2...0.1.0
1024 +
[0.0.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.0.1...0.0.2
1025 +
[0.0.1]: https://github.com/JetBrains/intellij-platform-plugin-template/commits/0.0.1
added CODE_OF_CONDUCT.md +4 −0
1 +
## Code of Conduct
2 +
3 +
This project and the corresponding community is governed by the [JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct). Please make sure you read it. 
4 +
added LICENSE +202 −0
1 +
2 +
                                 Apache License
3 +
                           Version 2.0, January 2004
4 +
                        http://www.apache.org/licenses/
5 +
6 +
   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 +
8 +
   1. Definitions.
9 +
10 +
      "License" shall mean the terms and conditions for use, reproduction,
11 +
      and distribution as defined by Sections 1 through 9 of this document.
12 +
13 +
      "Licensor" shall mean the copyright owner or entity authorized by
14 +
      the copyright owner that is granting the License.
15 +
16 +
      "Legal Entity" shall mean the union of the acting entity and all
17 +
      other entities that control, are controlled by, or are under common
18 +
      control with that entity. For the purposes of this definition,
19 +
      "control" means (i) the power, direct or indirect, to cause the
20 +
      direction or management of such entity, whether by contract or
21 +
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 +
      outstanding shares, or (iii) beneficial ownership of such entity.
23 +
24 +
      "You" (or "Your") shall mean an individual or Legal Entity
25 +
      exercising permissions granted by this License.
26 +
27 +
      "Source" form shall mean the preferred form for making modifications,
28 +
      including but not limited to software source code, documentation
29 +
      source, and configuration files.
30 +
31 +
      "Object" form shall mean any form resulting from mechanical
32 +
      transformation or translation of a Source form, including but
33 +
      not limited to compiled object code, generated documentation,
34 +
      and conversions to other media types.
35 +
36 +
      "Work" shall mean the work of authorship, whether in Source or
37 +
      Object form, made available under the License, as indicated by a
38 +
      copyright notice that is included in or attached to the work
39 +
      (an example is provided in the Appendix below).
40 +
41 +
      "Derivative Works" shall mean any work, whether in Source or Object
42 +
      form, that is based on (or derived from) the Work and for which the
43 +
      editorial revisions, annotations, elaborations, or other modifications
44 +
      represent, as a whole, an original work of authorship. For the purposes
45 +
      of this License, Derivative Works shall not include works that remain
46 +
      separable from, or merely link (or bind by name) to the interfaces of,
47 +
      the Work and Derivative Works thereof.
48 +
49 +
      "Contribution" shall mean any work of authorship, including
50 +
      the original version of the Work and any modifications or additions
51 +
      to that Work or Derivative Works thereof, that is intentionally
52 +
      submitted to Licensor for inclusion in the Work by the copyright owner
53 +
      or by an individual or Legal Entity authorized to submit on behalf of
54 +
      the copyright owner. For the purposes of this definition, "submitted"
55 +
      means any form of electronic, verbal, or written communication sent
56 +
      to the Licensor or its representatives, including but not limited to
57 +
      communication on electronic mailing lists, source code control systems,
58 +
      and issue tracking systems that are managed by, or on behalf of, the
59 +
      Licensor for the purpose of discussing and improving the Work, but
60 +
      excluding communication that is conspicuously marked or otherwise
61 +
      designated in writing by the copyright owner as "Not a Contribution."
62 +
63 +
      "Contributor" shall mean Licensor and any individual or Legal Entity
64 +
      on behalf of whom a Contribution has been received by Licensor and
65 +
      subsequently incorporated within the Work.
66 +
67 +
   2. Grant of Copyright License. Subject to the terms and conditions of
68 +
      this License, each Contributor hereby grants to You a perpetual,
69 +
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 +
      copyright license to reproduce, prepare Derivative Works of,
71 +
      publicly display, publicly perform, sublicense, and distribute the
72 +
      Work and such Derivative Works in Source or Object form.
73 +
74 +
   3. Grant of Patent License. Subject to the terms and conditions of
75 +
      this License, each Contributor hereby grants to You a perpetual,
76 +
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 +
      (except as stated in this section) patent license to make, have made,
78 +
      use, offer to sell, sell, import, and otherwise transfer the Work,
79 +
      where such license applies only to those patent claims licensable
80 +
      by such Contributor that are necessarily infringed by their
81 +
      Contribution(s) alone or by combination of their Contribution(s)
82 +
      with the Work to which such Contribution(s) was submitted. If You
83 +
      institute patent litigation against any entity (including a
84 +
      cross-claim or counterclaim in a lawsuit) alleging that the Work
85 +
      or a Contribution incorporated within the Work constitutes direct
86 +
      or contributory patent infringement, then any patent licenses
87 +
      granted to You under this License for that Work shall terminate
88 +
      as of the date such litigation is filed.
89 +
90 +
   4. Redistribution. You may reproduce and distribute copies of the
91 +
      Work or Derivative Works thereof in any medium, with or without
92 +
      modifications, and in Source or Object form, provided that You
93 +
      meet the following conditions:
94 +
95 +
      (a) You must give any other recipients of the Work or
96 +
          Derivative Works a copy of this License; and
97 +
98 +
      (b) You must cause any modified files to carry prominent notices
99 +
          stating that You changed the files; and
100 +
101 +
      (c) You must retain, in the Source form of any Derivative Works
102 +
          that You distribute, all copyright, patent, trademark, and
103 +
          attribution notices from the Source form of the Work,
104 +
          excluding those notices that do not pertain to any part of
105 +
          the Derivative Works; and
106 +
107 +
      (d) If the Work includes a "NOTICE" text file as part of its
108 +
          distribution, then any Derivative Works that You distribute must
109 +
          include a readable copy of the attribution notices contained
110 +
          within such NOTICE file, excluding those notices that do not
111 +
          pertain to any part of the Derivative Works, in at least one
112 +
          of the following places: within a NOTICE text file distributed
113 +
          as part of the Derivative Works; within the Source form or
114 +
          documentation, if provided along with the Derivative Works; or,
115 +
          within a display generated by the Derivative Works, if and
116 +
          wherever such third-party notices normally appear. The contents
117 +
          of the NOTICE file are for informational purposes only and
118 +
          do not modify the License. You may add Your own attribution
119 +
          notices within Derivative Works that You distribute, alongside
120 +
          or as an addendum to the NOTICE text from the Work, provided
121 +
          that such additional attribution notices cannot be construed
122 +
          as modifying the License.
123 +
124 +
      You may add Your own copyright statement to Your modifications and
125 +
      may provide additional or different license terms and conditions
126 +
      for use, reproduction, or distribution of Your modifications, or
127 +
      for any such Derivative Works as a whole, provided Your use,
128 +
      reproduction, and distribution of the Work otherwise complies with
129 +
      the conditions stated in this License.
130 +
131 +
   5. Submission of Contributions. Unless You explicitly state otherwise,
132 +
      any Contribution intentionally submitted for inclusion in the Work
133 +
      by You to the Licensor shall be under the terms and conditions of
134 +
      this License, without any additional terms or conditions.
135 +
      Notwithstanding the above, nothing herein shall supersede or modify
136 +
      the terms of any separate license agreement you may have executed
137 +
      with Licensor regarding such Contributions.
138 +
139 +
   6. Trademarks. This License does not grant permission to use the trade
140 +
      names, trademarks, service marks, or product names of the Licensor,
141 +
      except as required for reasonable and customary use in describing the
142 +
      origin of the Work and reproducing the content of the NOTICE file.
143 +
144 +
   7. Disclaimer of Warranty. Unless required by applicable law or
145 +
      agreed to in writing, Licensor provides the Work (and each
146 +
      Contributor provides its Contributions) on an "AS IS" BASIS,
147 +
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 +
      implied, including, without limitation, any warranties or conditions
149 +
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 +
      PARTICULAR PURPOSE. You are solely responsible for determining the
151 +
      appropriateness of using or redistributing the Work and assume any
152 +
      risks associated with Your exercise of permissions under this License.
153 +
154 +
   8. Limitation of Liability. In no event and under no legal theory,
155 +
      whether in tort (including negligence), contract, or otherwise,
156 +
      unless required by applicable law (such as deliberate and grossly
157 +
      negligent acts) or agreed to in writing, shall any Contributor be
158 +
      liable to You for damages, including any direct, indirect, special,
159 +
      incidental, or consequential damages of any character arising as a
160 +
      result of this License or out of the use or inability to use the
161 +
      Work (including but not limited to damages for loss of goodwill,
162 +
      work stoppage, computer failure or malfunction, or any and all
163 +
      other commercial damages or losses), even if such Contributor
164 +
      has been advised of the possibility of such damages.
165 +
166 +
   9. Accepting Warranty or Additional Liability. While redistributing
167 +
      the Work or Derivative Works thereof, You may choose to offer,
168 +
      and charge a fee for, acceptance of support, warranty, indemnity,
169 +
      or other liability obligations and/or rights consistent with this
170 +
      License. However, in accepting such obligations, You may act only
171 +
      on Your own behalf and on Your sole responsibility, not on behalf
172 +
      of any other Contributor, and only if You agree to indemnify,
173 +
      defend, and hold each Contributor harmless for any liability
174 +
      incurred by, or claims asserted against, such Contributor by reason
175 +
      of your accepting any such warranty or additional liability.
176 +
177 +
   END OF TERMS AND CONDITIONS
178 +
179 +
   APPENDIX: How to apply the Apache License to your work.
180 +
181 +
      To apply the Apache License to your work, attach the following
182 +
      boilerplate notice, with the fields enclosed by brackets "[]"
183 +
      replaced with your own identifying information. (Don't include
184 +
      the brackets!)  The text should be enclosed in the appropriate
185 +
      comment syntax for the file format. We also recommend that a
186 +
      file or class name and description of purpose be included on the
187 +
      same "printed page" as the copyright notice for easier
188 +
      identification within third-party archives.
189 +
190 +
   Copyright 2000-2021 JetBrains s.r.o.
191 +
192 +
   Licensed under the Apache License, Version 2.0 (the "License");
193 +
   you may not use this file except in compliance with the License.
194 +
   You may obtain a copy of the License at
195 +
196 +
       http://www.apache.org/licenses/LICENSE-2.0
197 +
198 +
   Unless required by applicable law or agreed to in writing, software
199 +
   distributed under the License is distributed on an "AS IS" BASIS,
200 +
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 +
   See the License for the specific language governing permissions and
202 +
   limitations under the License.
added build.gradle.kts +18 −0
1 +
import org.jetbrains.intellij.platform.gradle.TestFrameworkType
2 +
3 +
plugins {
4 +
    id("org.jetbrains.kotlin.jvm")
5 +
    id("org.jetbrains.intellij.platform")
6 +
    id("org.jetbrains.changelog")
7 +
}
8 +
9 +
dependencies {
10 +
    testImplementation("junit:junit:4.13.2")
11 +
12 +
    // IntelliJ Platform Gradle Plugin Dependencies Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html
13 +
    intellijPlatform {
14 +
        intellijIdea("2026.2.3")
15 +
        testFramework(TestFrameworkType.Platform)
16 +
        testBundledPlugins("com.intellij.modules.ultimate")
17 +
    }
18 +
}
added gradle.properties +13 −0
1 +
group = org.jetbrains.plugins.template
2 +
version = 2.6.0
3 +
4 +
pluginRepositoryUrl = https://github.com/JetBrains/intellij-platform-plugin-template
5 +
6 +
# Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib
7 +
kotlin.stdlib.default.dependency = false
8 +
9 +
# Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html
10 +
org.gradle.configuration-cache = true
11 +
12 +
# Enable Gradle Build Cache -> https://docs.gradle.org/current/userguide/build_cache.html
13 +
org.gradle.caching = true
added gradle/wrapper/gradle-wrapper.jar +0 −0

No line changes.

added gradle/wrapper/gradle-wrapper.properties +9 −0
1 +
distributionBase=GRADLE_USER_HOME
2 +
distributionPath=wrapper/dists
3 +
distributionUrl=https\://services.gradle.org/distributions/gradle-9.8.1-bin.zip
4 +
networkTimeout=10000
5 +
retries=0
6 +
retryBackOffMs=500
7 +
validateDistributionUrl=true
8 +
zipStoreBase=GRADLE_USER_HOME
9 +
zipStorePath=wrapper/dists
added gradlew +248 −0
1 +
#!/bin/sh
2 +
3 +
#
4 +
# Copyright © 2015 the original authors.
5 +
#
6 +
# Licensed under the Apache License, Version 2.0 (the "License");
7 +
# you may not use this file except in compliance with the License.
8 +
# You may obtain a copy of the License at
9 +
#
10 +
#      https://www.apache.org/licenses/LICENSE-2.0
11 +
#
12 +
# Unless required by applicable law or agreed to in writing, software
13 +
# distributed under the License is distributed on an "AS IS" BASIS,
14 +
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 +
# See the License for the specific language governing permissions and
16 +
# limitations under the License.
17 +
#
18 +
# SPDX-License-Identifier: Apache-2.0
19 +
#
20 +
21 +
##############################################################################
22 +
#
23 +
#   gradlew start up script for POSIX generated by Gradle.
24 +
#
25 +
#   Important for running:
26 +
#
27 +
#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28 +
#       noncompliant, but you have some other compliant shell such as ksh or
29 +
#       bash, then to run this script, type that shell name before the whole
30 +
#       command line, like:
31 +
#
32 +
#           ksh gradlew
33 +
#
34 +
#       Busybox and similar reduced shells will NOT work, because this script
35 +
#       requires all of these POSIX shell features:
36 +
#         * functions;
37 +
#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38 +
#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39 +
#         * compound commands having a testable exit status, especially «case»;
40 +
#         * various built-in commands including «command», «set», and «ulimit».
41 +
#
42 +
#   Important for patching:
43 +
#
44 +
#   (2) This script targets any POSIX shell, so it avoids extensions provided
45 +
#       by Bash, Ksh, etc; in particular arrays are avoided.
46 +
#
47 +
#       The "traditional" practice of packing multiple parameters into a
48 +
#       space-separated string is a well documented source of bugs and security
49 +
#       problems, so this is (mostly) avoided, by progressively accumulating
50 +
#       options in "$@", and eventually passing that to Java.
51 +
#
52 +
#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53 +
#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54 +
#       see the in-line comments for details.
55 +
#
56 +
#       There are tweaks for specific operating systems such as AIX, CygWin,
57 +
#       Darwin, MinGW, and NonStop.
58 +
#
59 +
#   (3) This script is generated from the Groovy template
60 +
#       https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61 +
#       within the Gradle project.
62 +
#
63 +
#       You can find Gradle at https://github.com/gradle/gradle/.
64 +
#
65 +
##############################################################################
66 +
67 +
# Attempt to set APP_HOME
68 +
69 +
# Resolve links: $0 may be a link
70 +
app_path=$0
71 +
72 +
# Need this for daisy-chained symlinks.
73 +
while
74 +
    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
75 +
    [ -h "$app_path" ]
76 +
do
77 +
    ls=$( ls -ld "$app_path" )
78 +
    link=${ls#*' -> '}
79 +
    case $link in             #(
80 +
      /*)   app_path=$link ;; #(
81 +
      *)    app_path=$APP_HOME$link ;;
82 +
    esac
83 +
done
84 +
85 +
# This is normally unused
86 +
# shellcheck disable=SC2034
87 +
APP_BASE_NAME=${0##*/}
88 +
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89 +
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
90 +
91 +
# Use the maximum available, or set MAX_FD != -1 to use that value.
92 +
MAX_FD=maximum
93 +
94 +
warn () {
95 +
    echo "$*"
96 +
} >&2
97 +
98 +
die () {
99 +
    echo
100 +
    echo "$*"
101 +
    echo
102 +
    exit 1
103 +
} >&2
104 +
105 +
# OS specific support (must be 'true' or 'false').
106 +
cygwin=false
107 +
msys=false
108 +
darwin=false
109 +
nonstop=false
110 +
case "$( uname )" in                #(
111 +
  CYGWIN* )         cygwin=true  ;; #(
112 +
  Darwin* )         darwin=true  ;; #(
113 +
  MSYS* | MINGW* )  msys=true    ;; #(
114 +
  NONSTOP* )        nonstop=true ;;
115 +
esac
116 +
117 +
118 +
119 +
# Determine the Java command to use to start the JVM.
120 +
if [ -n "$JAVA_HOME" ] ; then
121 +
    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
122 +
        # IBM's JDK on AIX uses strange locations for the executables
123 +
        JAVACMD=$JAVA_HOME/jre/sh/java
124 +
    else
125 +
        JAVACMD=$JAVA_HOME/bin/java
126 +
    fi
127 +
    if [ ! -x "$JAVACMD" ] ; then
128 +
        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
129 +
130 +
Please set the JAVA_HOME variable in your environment to match the
131 +
location of your Java installation."
132 +
    fi
133 +
else
134 +
    JAVACMD=java
135 +
    if ! command -v java >/dev/null 2>&1
136 +
    then
137 +
        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
138 +
139 +
Please set the JAVA_HOME variable in your environment to match the
140 +
location of your Java installation."
141 +
    fi
142 +
fi
143 +
144 +
# Increase the maximum file descriptors if we can.
145 +
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
146 +
    case $MAX_FD in #(
147 +
      max*)
148 +
        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
149 +
        # shellcheck disable=SC2039,SC3045
150 +
        MAX_FD=$( ulimit -H -n ) ||
151 +
            warn "Could not query maximum file descriptor limit"
152 +
    esac
153 +
    case $MAX_FD in  #(
154 +
      '' | soft) :;; #(
155 +
      *)
156 +
        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
157 +
        # shellcheck disable=SC2039,SC3045
158 +
        ulimit -n "$MAX_FD" ||
159 +
            warn "Could not set maximum file descriptor limit to $MAX_FD"
160 +
    esac
161 +
fi
162 +
163 +
# Collect all arguments for the java command, stacking in reverse order:
164 +
#   * args from the command line
165 +
#   * the main class name
166 +
#   * -classpath
167 +
#   * -D...appname settings
168 +
#   * --module-path (only if needed)
169 +
#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
170 +
171 +
# For Cygwin or MSYS, switch paths to Windows format before running java
172 +
if "$cygwin" || "$msys" ; then
173 +
    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
174 +
175 +
    JAVACMD=$( cygpath --unix "$JAVACMD" )
176 +
177 +
    # Now convert the arguments - kludge to limit ourselves to /bin/sh
178 +
    for arg do
179 +
        if
180 +
            case $arg in                                #(
181 +
              -*)   false ;;                            # don't mess with options #(
182 +
              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
183 +
                    [ -e "$t" ] ;;                      #(
184 +
              *)    false ;;
185 +
            esac
186 +
        then
187 +
            arg=$( cygpath --path --ignore --mixed "$arg" )
188 +
        fi
189 +
        # Roll the args list around exactly as many times as the number of
190 +
        # args, so each arg winds up back in the position where it started, but
191 +
        # possibly modified.
192 +
        #
193 +
        # NB: a `for` loop captures its iteration list before it begins, so
194 +
        # changing the positional parameters here affects neither the number of
195 +
        # iterations, nor the values presented in `arg`.
196 +
        shift                   # remove old arg
197 +
        set -- "$@" "$arg"      # push replacement arg
198 +
    done
199 +
fi
200 +
201 +
202 +
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
203 +
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
204 +
205 +
# Collect all arguments for the java command:
206 +
#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
207 +
#     and any embedded shellness will be escaped.
208 +
#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
209 +
#     treated as '${Hostname}' itself on the command line.
210 +
211 +
set -- \
212 +
        "-Dorg.gradle.appname=$APP_BASE_NAME" \
213 +
        -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
214 +
        "$@"
215 +
216 +
# Stop when "xargs" is not available.
217 +
if ! command -v xargs >/dev/null 2>&1
218 +
then
219 +
    die "xargs is not available"
220 +
fi
221 +
222 +
# Use "xargs" to parse quoted args.
223 +
#
224 +
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
225 +
#
226 +
# In Bash we could simply go:
227 +
#
228 +
#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
229 +
#   set -- "${ARGS[@]}" "$@"
230 +
#
231 +
# but POSIX shell has neither arrays nor command substitution, so instead we
232 +
# post-process each arg (as a line of input to sed) to backslash-escape any
233 +
# character that might be a shell metacharacter, then use eval to reverse
234 +
# that process (while maintaining the separation between arguments), and wrap
235 +
# the whole thing up as a single "set" statement.
236 +
#
237 +
# This will of course break if any of these variables contains a newline or
238 +
# an unmatched quote.
239 +
#
240 +
241 +
eval "set -- $(
242 +
        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
243 +
        xargs -n1 |
244 +
        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
245 +
        tr '\n' ' '
246 +
    )" '"$@"'
247 +
248 +
exec "$JAVACMD" "$@"
added gradlew.bat +112 −0
1 +
@rem
2 +
@rem Copyright 2015 the original author or authors.
3 +
@rem
4 +
@rem Licensed under the Apache License, Version 2.0 (the "License");
5 +
@rem you may not use this file except in compliance with the License.
6 +
@rem You may obtain a copy of the License at
7 +
@rem
8 +
@rem      https://www.apache.org/licenses/LICENSE-2.0
9 +
@rem
10 +
@rem Unless required by applicable law or agreed to in writing, software
11 +
@rem distributed under the License is distributed on an "AS IS" BASIS,
12 +
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 +
@rem See the License for the specific language governing permissions and
14 +
@rem limitations under the License.
15 +
@rem
16 +
@rem SPDX-License-Identifier: Apache-2.0
17 +
@rem
18 +
19 +
@if "%DEBUG%"=="" @echo off
20 +
@rem ##########################################################################
21 +
@rem
22 +
@rem  gradlew startup script for Windows
23 +
@rem
24 +
@rem ##########################################################################
25 +
26 +
@rem Set local scope for the variables, and ensure extensions are enabled
27 +
setlocal EnableExtensions
28 +
29 +
@rem Catch executions from older scripts and ensure they exit cleanly.
30 +
@rem This can be removed once we can be reasonably confident that few people
31 +
@rem will be migrating directly to this new wrapper.
32 +
goto afterSafetyNet
33 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
34 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
35 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
36 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
37 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
38 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
39 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
40 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
41 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
42 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
43 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
44 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
45 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
46 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
47 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
48 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
49 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
50 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
51 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
52 +
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
53 +
goto exitWithErrorLevel
54 +
:afterSafetyNet
55 +
56 +
set DIRNAME=%~dp0
57 +
if "%DIRNAME%"=="" set DIRNAME=.
58 +
@rem This is normally unused
59 +
set APP_BASE_NAME=%~n0
60 +
set APP_HOME=%DIRNAME%
61 +
62 +
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
63 +
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
64 +
65 +
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
66 +
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
67 +
68 +
@rem Find java.exe
69 +
if defined JAVA_HOME goto findJavaFromJavaHome
70 +
71 +
set JAVA_EXE=java.exe
72 +
%JAVA_EXE% -version >NUL 2>&1
73 +
if %ERRORLEVEL% equ 0 goto execute
74 +
75 +
1>&2 echo.
76 +
1>&2 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
77 +
1>&2 echo.
78 +
1>&2 echo Please set the JAVA_HOME variable in your environment to match the
79 +
1>&2 echo location of your Java installation.
80 +
81 +
"%COMSPEC%" /c exit 1
82 +
goto exitWithErrorLevel
83 +
84 +
:findJavaFromJavaHome
85 +
set JAVA_HOME=%JAVA_HOME:"=%
86 +
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
87 +
88 +
if exist "%JAVA_EXE%" goto execute
89 +
90 +
1>&2 echo.
91 +
1>&2 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
92 +
1>&2 echo.
93 +
1>&2 echo Please set the JAVA_HOME variable in your environment to match the
94 +
1>&2 echo location of your Java installation.
95 +
96 +
"%COMSPEC%" /c exit 1
97 +
goto exitWithErrorLevel
98 +
99 +
:execute
100 +
@rem Setup the command line
101 +
102 +
103 +
104 +
@rem Execute gradlew
105 +
@rem endlocal doesn't take effect until after the line is parsed and variables are expanded
106 +
@rem which allows us to clear the local environment before executing the java command
107 +
endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel & goto exitWithErrorLevel
108 +
109 +
@rem This label must not be changed. We rely on old scripts being able to jump to this point.
110 +
:exitWithErrorLevel
111 +
@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts
112 +
"%COMSPEC%" /c exit %ERRORLEVEL%
added settings.gradle.kts +28 −0
1 +
import org.jetbrains.intellij.platform.gradle.extensions.intellijPlatform
2 +
3 +
rootProject.name = "IntelliJ Platform Plugin Template"
4 +
5 +
pluginManagement {
6 +
    plugins {
7 +
        id("org.jetbrains.kotlin.jvm") version "2.4.21"
8 +
        id("org.jetbrains.changelog") version "2.5.0"
9 +
    }
10 +
}
11 +
12 +
plugins {
13 +
    id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
14 +
    id("org.jetbrains.intellij.platform.settings") version "2.19.0"
15 +
}
16 +
17 +
@Suppress("UnstableApiUsage")
18 +
dependencyResolutionManagement {
19 +
    // Configure all projects' repositories
20 +
    repositories {
21 +
        mavenCentral()
22 +
23 +
        // IntelliJ Platform Gradle Plugin Repositories Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-repositories-extension.html
24 +
        intellijPlatform {
25 +
            defaultRepositories()
26 +
        }
27 +
    }
28 +
}
added src/main/kotlin/org/jetbrains/plugins/template/MyBundle.kt +23 −0
1 +
package org.jetbrains.plugins.template
2 +
3 +
import com.intellij.DynamicBundle
4 +
import org.jetbrains.annotations.NonNls
5 +
import org.jetbrains.annotations.PropertyKey
6 +
7 +
@NonNls
8 +
private const val BUNDLE = "messages.MyBundle"
9 +
10 +
object MyBundle : DynamicBundle(BUNDLE) {
11 +
12 +
    operator fun get(@PropertyKey(resourceBundle = BUNDLE) key: String, vararg params: Any) =
13 +
        getMessage(key, *params)
14 +
15 +
    @JvmStatic
16 +
    fun message(@PropertyKey(resourceBundle = BUNDLE) key: String, vararg params: Any) =
17 +
        getMessage(key, *params)
18 +
19 +
    @Suppress("unused")
20 +
    @JvmStatic
21 +
    fun messagePointer(@PropertyKey(resourceBundle = BUNDLE) key: String, vararg params: Any) =
22 +
        getLazyMessage(key, *params)
23 +
}
added src/main/kotlin/org/jetbrains/plugins/template/services/MyProjectService.kt +17 −0
1 +
package org.jetbrains.plugins.template.services
2 +
3 +
import com.intellij.openapi.components.Service
4 +
import com.intellij.openapi.diagnostic.thisLogger
5 +
import com.intellij.openapi.project.Project
6 +
import org.jetbrains.plugins.template.MyBundle
7 +
8 +
@Service(Service.Level.PROJECT)
9 +
class MyProjectService(project: Project) {
10 +
11 +
    init {
12 +
        thisLogger().info(MyBundle["projectService", project.name])
13 +
        thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.")
14 +
    }
15 +
16 +
    fun getRandomNumber() = (1..100).random()
17 +
}
added src/main/kotlin/org/jetbrains/plugins/template/startup/MyProjectActivity.kt +12 −0
1 +
package org.jetbrains.plugins.template.startup
2 +
3 +
import com.intellij.openapi.diagnostic.thisLogger
4 +
import com.intellij.openapi.project.Project
5 +
import com.intellij.openapi.startup.ProjectActivity
6 +
7 +
class MyProjectActivity : ProjectActivity {
8 +
9 +
    override suspend fun execute(project: Project) {
10 +
        thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.")
11 +
    }
12 +
}
added src/main/kotlin/org/jetbrains/plugins/template/toolWindow/MyToolWindowFactory.kt +45 −0
1 +
package org.jetbrains.plugins.template.toolWindow
2 +
3 +
import com.intellij.openapi.components.service
4 +
import com.intellij.openapi.diagnostic.thisLogger
5 +
import com.intellij.openapi.project.Project
6 +
import com.intellij.openapi.wm.ToolWindow
7 +
import com.intellij.openapi.wm.ToolWindowFactory
8 +
import com.intellij.ui.components.JBLabel
9 +
import com.intellij.ui.components.JBPanel
10 +
import com.intellij.ui.content.ContentFactory
11 +
import org.jetbrains.plugins.template.MyBundle
12 +
import org.jetbrains.plugins.template.services.MyProjectService
13 +
import javax.swing.JButton
14 +
15 +
16 +
class MyToolWindowFactory : ToolWindowFactory {
17 +
18 +
    init {
19 +
        thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.")
20 +
    }
21 +
22 +
    override fun createToolWindowContent(project: Project, toolWindow: ToolWindow) {
23 +
        val myToolWindow = MyToolWindow(toolWindow)
24 +
        val content = ContentFactory.getInstance().createContent(myToolWindow.getContent(), null, false)
25 +
        toolWindow.contentManager.addContent(content)
26 +
    }
27 +
28 +
    override fun shouldBeAvailable(project: Project) = true
29 +
30 +
    class MyToolWindow(toolWindow: ToolWindow) {
31 +
32 +
        private val service = toolWindow.project.service<MyProjectService>()
33 +
34 +
        fun getContent() = JBPanel<JBPanel<*>>().apply {
35 +
            val label = JBLabel(MyBundle["randomLabel", "?"])
36 +
37 +
            add(label)
38 +
            add(JButton(MyBundle["shuffle"]).apply {
39 +
                addActionListener {
40 +
                    label.text = MyBundle["randomLabel", service.getRandomNumber()]
41 +
                }
42 +
            })
43 +
        }
44 +
    }
45 +
}
added src/main/resources/META-INF/plugin.xml +19 −0
1 +
<!-- Plugin Configuration File. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html -->
2 +
<idea-plugin>
3 +
    <id>org.jetbrains.plugins.template</id>
4 +
    <name>IntelliJ Platform Plugin Template</name>
5 +
    <vendor>JetBrains</vendor>
6 +
    <description><![CDATA[
7 +
        <p><b>IntelliJ Platform Plugin Template</b> is a repository that provides a pure template to make it easier to create a new plugin project.</p>
8 +
        <p>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.</p>
9 +
    ]]></description>
10 +
11 +
    <depends>com.intellij.modules.platform</depends>
12 +
13 +
    <resource-bundle>messages.MyBundle</resource-bundle>
14 +
15 +
    <extensions defaultExtensionNs="com.intellij">
16 +
        <toolWindow factoryClass="org.jetbrains.plugins.template.toolWindow.MyToolWindowFactory" id="MyToolWindow"/>
17 +
        <postStartupActivity implementation="org.jetbrains.plugins.template.startup.MyProjectActivity" />
18 +
    </extensions>
19 +
</idea-plugin>
added src/main/resources/messages/MyBundle.properties +3 −0
1 +
projectService=Project service: {0}
2 +
randomLabel=The random number is: {0}
3 +
shuffle=Shuffle
added src/test/kotlin/org/jetbrains/plugins/template/MyPluginTest.kt +39 −0
1 +
package org.jetbrains.plugins.template
2 +
3 +
import com.intellij.ide.highlighter.XmlFileType
4 +
import com.intellij.openapi.components.service
5 +
import com.intellij.psi.xml.XmlFile
6 +
import com.intellij.testFramework.TestDataPath
7 +
import com.intellij.testFramework.fixtures.BasePlatformTestCase
8 +
import com.intellij.util.PsiErrorElementUtil
9 +
import org.jetbrains.plugins.template.services.MyProjectService
10 +
11 +
@TestDataPath("\$CONTENT_ROOT/src/test/testData")
12 +
class MyPluginTest : BasePlatformTestCase() {
13 +
14 +
    fun testXMLFile() {
15 +
        val psiFile = myFixture.configureByText(XmlFileType.INSTANCE, "<foo>bar</foo>")
16 +
        val xmlFile = assertInstanceOf(psiFile, XmlFile::class.java)
17 +
18 +
        assertFalse(PsiErrorElementUtil.hasErrors(project, xmlFile.virtualFile))
19 +
20 +
        assertNotNull(xmlFile.rootTag)
21 +
22 +
        xmlFile.rootTag?.let {
23 +
            assertEquals("foo", it.name)
24 +
            assertEquals("bar", it.value.text)
25 +
        }
26 +
    }
27 +
28 +
    fun testRename() {
29 +
        myFixture.testRename("foo.xml", "foo_after.xml", "a2")
30 +
    }
31 +
32 +
    fun testProjectService() {
33 +
        val projectService = project.service<MyProjectService>()
34 +
35 +
        assertNotSame(projectService.getRandomNumber(), projectService.getRandomNumber())
36 +
    }
37 +
38 +
    override fun getTestDataPath() = "src/test/testData/rename"
39 +
}
added src/test/testData/rename/foo.xml +3 −0
1 +
<root>
2 +
    <a<caret>1>Foo</a1>
3 +
</root>
added src/test/testData/rename/foo_after.xml +3 −0
1 +
<root>
2 +
    <a2>Foo</a2>
3 +
</root>
modified README.md +541 −1
1 -
OxygenHub for IntelliJ
1 +
# IntelliJ Platform Plugin Template
2 +
3 +
[![official JetBrains project](https://jb.gg/badges/official.svg)][jb:github]
4 +
[![Twitter Follow](https://img.shields.io/badge/follow-%40JBPlatform-1DA1F2?logo=twitter)](https://x.com/JBPlatform)
5 +
[![Build](https://github.com/JetBrains/intellij-platform-plugin-template/workflows/Build/badge.svg)][gh:build]
6 +
7 +
![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-dark]
8 +
![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-light]
9 +
10 +
> [!NOTE]
11 +
> Click the <kbd>Use this template</kbd> button and clone it in IntelliJ IDEA.
12 +
13 +
**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).
14 +
15 +
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.
16 +
17 +
[gh:template]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
18 +
19 +
If you're still not quite sure what this is all about, read our introduction: [What is the IntelliJ Platform?][docs:intro]
20 +
21 +
> [!NOTE]
22 +
> Click the <kbd>Watch</kbd> button on the top to be notified about releases containing new features and fixes.
23 +
24 +
### Table of contents
25 +
26 +
In this README, we will highlight the following elements of template-project creation:
27 +
28 +
- [Getting started](#getting-started)
29 +
- [Gradle configuration](#gradle-configuration)
30 +
- [Plugin template structure](#plugin-template-structure)
31 +
- [Plugin configuration file](#plugin-configuration-file)
32 +
- [Sample code](#sample-code):
33 +
  - startup activity – project-open sample
34 +
  - services – project-level service
35 +
  - tool window – sample UI entry point
36 +
- [Testing](#testing)
37 +
  - [Functional tests](#functional-tests)
38 +
  - [UI tests](#ui-tests)
39 +
- [Predefined Run/Debug configurations](#predefined-rundebug-configurations)
40 +
- [Continuous integration](#continuous-integration) based on GitHub Actions
41 +
  - [Dependencies management](#dependencies-management) with Dependabot
42 +
  - [Changelog maintenance](#changelog-maintenance) with the Gradle Changelog Plugin
43 +
  - [Release flow](#release-flow) using GitHub Releases
44 +
  - [Plugin signing](#plugin-signing) with Marketplace signing
45 +
  - [Publishing the plugin](#publishing-the-plugin) with the IntelliJ Platform Gradle Plugin
46 +
- [FAQ](#faq)
47 +
- [Useful links](#useful-links)
48 +
49 +
50 +
## Getting started
51 +
52 +
Before we dive into plugin development and everything related to it, it's worth mentioning the benefits of using GitHub Templates.
53 +
By creating a new project using the current template, you start with no history or reference to this repository.
54 +
This allows you to create a new repository easily without copying and pasting previous content, cloning repositories, or clearing the history manually.
55 +
56 +
All you have to do is click the <kbd>Use this template</kbd> button (you must be logged in with your GitHub account).
57 +
58 +
![Use this template][file:use-this-template.png]
59 +
60 +
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.
61 +
Once 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_.
62 +
63 +
Now the project is ready to be cloned to your local environment and opened with [IntelliJ IDEA][jb:download-ij].
64 +
65 +
The most convenient way for getting your new project from GitHub is the <kbd>Get from VCS</kbd> action available on the Welcome Screen, where you can filter your GitHub repository by its name.
66 +
67 +
![Get from Version Control][file:get-from-version-control]
68 +
69 +
The next step, after opening your project in IntelliJ IDEA, is to set the proper <kbd>SDK</kbd> to Java in version `21` within the [Project Structure settings][docs:project-structure-settings].
70 +
71 +
![Project Structure — SDK][file:project-structure-sdk.png]
72 +
73 +
For 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.
74 +
Then you can get to work implementing your ideas.
75 +
76 +
> [!NOTE]
77 +
> To use Java in your plugin, create the `/src/main/java` directory.
78 +
79 +
80 +
## Gradle configuration
81 +
82 +
The recommended method for plugin development involves using the [Gradle][gradle] setup with the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin] installed.
83 +
The IntelliJ Platform Gradle Plugin makes it possible to run the IDE with your plugin and publish your plugin to JetBrains Marketplace.
84 +
85 +
> [!NOTE]
86 +
> Make sure to always upgrade to the latest version of IntelliJ Platform Gradle Plugin.
87 +
88 +
A project built using the IntelliJ Platform Plugin Template includes a Gradle configuration already set up.
89 +
Feel free to read through the [Using Gradle][docs:using-gradle] articles to understand your build better and learn how to customize it.
90 +
91 +
The most significant parts of the current configuration are:
92 +
- Integration with the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin] for smoother development.
93 +
- Repository configuration moved to [`settings.gradle.kts`][file:settings.gradle.kts] using the IntelliJ Platform repositories extension.
94 +
- Configuration written with [Gradle Kotlin DSL][gradle:kotlin-dsl].
95 +
- Support for Kotlin and Java implementation.
96 +
- Plugin and dependency versions are declared directly in the Gradle build files.
97 +
- Integration with the [gradle-changelog-plugin][gh:gradle-changelog-plugin], which automatically patches the change notes based on the `CHANGELOG.md` file.
98 +
- [Plugin publishing][docs:publishing] through the `publishPlugin` task and GitHub Actions workflows.
99 +
100 +
For more details regarding Kotlin integration, please see [Kotlin for Plugin Developers][docs:kotlin] in the IntelliJ Platform Plugin SDK documentation.
101 +
102 +
The current target is IntelliJ IDEA 2026.2, with minimum platform build `262` and Java 25 required for compilation and testing.
103 +
The IntelliJ Platform Gradle Plugin provisions the matching toolchain; Gradle itself can still run on Java 21, as it does in CI.
104 +
105 +
### Gradle properties
106 +
107 +
The project-specific configuration file [`gradle.properties`][file:gradle.properties] starts with values expected to vary between repositories created from this template:
108 +
109 +
| Property name         | Description                                                                                          |
110 +
|-----------------------|------------------------------------------------------------------------------------------------------|
111 +
| `group`               | Project group and default base package for the sample sources.                                      |
112 +
| `version`             | Current plugin version in [SemVer][semver] format.                                                   |
113 +
| `pluginRepositoryUrl` | Repository URL used for generating URLs by the [Gradle Changelog Plugin][gh:gradle-changelog-plugin] |
114 +
115 +
The remaining plugin metadata lives closer to where it is used:
116 +
- [`settings.gradle.kts`][file:settings.gradle.kts] declares Gradle plugin versions and repository management.
117 +
- [`build.gradle.kts`][file:build.gradle.kts] declares the target IntelliJ Platform version and project dependencies.
118 +
- [`plugin.xml`][file:plugin.xml] contains the plugin `id`, `name`, `vendor`, `description`, and extension registrations.
119 +
120 +
It also configures Gradle build behavior flags, such as:
121 +
122 +
| Property name                                    | Value   | Description                                                                                    |
123 +
|--------------------------------------------------|---------|------------------------------------------------------------------------------------------------|
124 +
| `kotlin.stdlib.default.dependency`               | `false` | Opt-out flag for bundling [Kotlin standard library][docs:kotlin-stdlib]                        |
125 +
| `org.gradle.configuration-cache`                 | `true`  | Enable [Gradle Configuration Cache][gradle:configuration-cache]                                |
126 +
| `org.gradle.caching`                             | `true`  | Enable [Gradle Build Cache][gradle:build-cache]                                                |
127 +
128 +
### Environment variables
129 +
130 +
Some values used during signing and publishing should not be stored in project files.
131 +
132 +
Provide them through local *Run/Debug Configurations* or on CI, for example in GitHub under `Settings > Secrets and variables > Actions`.
133 +
134 +
The current template uses the following variables for the [plugin signing](#plugin-signing) and [publishing](#publishing-the-plugin) flow:
135 +
136 +
| Environment variable name | Description                                                                                                  |
137 +
|---------------------------|--------------------------------------------------------------------------------------------------------------|
138 +
| `PRIVATE_KEY`             | Certificate private key, should contain: `-----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY-----` |
139 +
| `PRIVATE_KEY_PASSWORD`    | Password used for encrypting the certificate file.                                                           |
140 +
| `CERTIFICATE_CHAIN`       | Certificate chain, should contain: `-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----`                |
141 +
| `PUBLISH_TOKEN`           | Publishing token generated in your JetBrains Marketplace profile dashboard.                                  |
142 +
143 +
For more details on how to generate proper values, check the relevant sections mentioned above.
144 +
145 +
To configure GitHub secret environment variables, go to the `⚙️ Settings > Secrets and variables > Actions` section of your project repository:
146 +
147 +
![Settings > Secrets][file:settings-secrets.png]
148 +
149 +
## Plugin template structure
150 +
151 +
A generated IntelliJ Platform Plugin Template repository contains the following content structure:
152 +
153 +
```
154 +
.
155 +
├── .github/                GitHub Actions workflows and Dependabot configuration files
156 +
├── .run/                   Predefined Run/Debug Configurations
157 +
├── gradle
158 +
│   └── wrapper/            Gradle Wrapper
159 +
├── src                     Plugin sources
160 +
│   ├── main
161 +
│   │   ├── kotlin/         Kotlin production sources
162 +
│   │   └── resources/      Resources - plugin.xml, icons, messages
163 +
│   └── test
164 +
│       ├── kotlin/         Kotlin test sources
165 +
│       └── testData/       Test data used by tests
166 +
├── .gitignore              Git ignoring rules
167 +
├── build.gradle.kts        Gradle configuration
168 +
├── CHANGELOG.md            Full change history
169 +
├── gradle.properties       Gradle configuration properties
170 +
├── gradlew                 *nix Gradle Wrapper script
171 +
├── gradlew.bat             Windows Gradle Wrapper script
172 +
├── LICENSE                 License, MIT by default
173 +
├── README.md               README
174 +
└── settings.gradle.kts     Gradle project settings and repositories
175 +
```
176 +
177 +
In 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].
178 +
179 +
> [!NOTE]
180 +
> To use Java in your plugin, create the `/src/main/java` directory.
181 +
182 +
183 +
## Plugin configuration file
184 +
185 +
The plugin configuration file is a [plugin.xml][file:plugin.xml] file located in the `src/main/resources/META-INF` directory.
186 +
It provides general information about the plugin, its dependencies, and its extensions.
187 +
Maintain the plugin description directly in this file, using HTML wrapped in CDATA when needed.
188 +
189 +
> [!NOTE]
190 +
> When using this template for a real plugin, replace the placeholder description with content that describes the final plugin.
191 +
192 +
```xml
193 +
<idea-plugin>
194 +
  <id>org.jetbrains.plugins.template</id>
195 +
  <name>IntelliJ Platform Plugin Template</name>
196 +
  <vendor>JetBrains</vendor>
197 +
  <description><![CDATA[
198 +
    <p>Plugin description in HTML.</p>
199 +
  ]]></description>
200 +
201 +
  <depends>com.intellij.modules.platform</depends>
202 +
203 +
  <resource-bundle>messages.MyBundle</resource-bundle>
204 +
205 +
  <extensions defaultExtensionNs="com.intellij">
206 +
    <toolWindow factoryClass="..." id="..."/>
207 +
    <postStartupActivity implementation="..."/>
208 +
  </extensions>
209 +
</idea-plugin>
210 +
```
211 +
212 +
You can read more about this file in the [Plugin Configuration File][docs:plugin.xml] section of our documentation.
213 +
214 +
215 +
## Sample code
216 +
217 +
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).
218 +
Therefore, the template contains only the following files:
219 +
220 +
```
221 +
.
222 +
├── startup
223 +
│   └── MyProjectActivity.kt                Project startup activity
224 +
├── services
225 +
│   └── MyProjectService.kt                 Project-level service
226 +
├── toolWindow
227 +
│   └── MyToolWindowFactory.kt              Tool window factory — creates tool window content
228 +
└── MyBundle.kt                             Bundle class providing access to the resources messages
229 +
```
230 +
231 +
These files are located in `src/main/kotlin`.
232 +
This location indicates the language being used.
233 +
So if you decide to use Java instead (or in addition to Kotlin), these sources should be located in the `src/main/java` directory.
234 +
235 +
> [!TIP]
236 +
> It is possible to use the [IntelliJ Platform Icons](https://jb.gg/new-ui-icons) in your plugin.
237 +
238 +
To 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.
239 +
240 +
> [!WARNING]
241 +
> Remember to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.
242 +
243 +
For 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.
244 +
245 +
## Testing
246 +
247 +
[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.
248 +
The IntelliJ Platform Plugin Template project ships with functional test examples and leaves UI testing setup to the plugin author.
249 +
250 +
### Functional tests
251 +
252 +
Most of the IntelliJ Platform codebase tests are model-level, run in a headless environment using an actual IDE instance.
253 +
The tests usually test a feature as a whole rather than individual functions that comprise its implementation, like in unit tests.
254 +
255 +
In `src/test/kotlin`, 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/test/testData/rename` test resources.
256 +
257 +
> [!NOTE]
258 +
> Run your tests using predefined *Run Tests* configuration or by invoking the `./gradlew check` Gradle task.
259 +
260 +
### UI tests
261 +
262 +
If your plugin provides complex user interfaces, you should consider covering them with tests and the functionality they use.
263 +
264 +
The template does not wire UI testing into the Gradle build by default anymore.
265 +
If 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.
266 +
267 +
268 +
## Predefined Run/Debug configurations
269 +
270 +
Within the default project structure, there is a `.run` directory provided containing predefined *Run/Debug configurations* that expose corresponding Gradle tasks:
271 +
272 +
![Run/Debug configurations][file:run-debug-configurations.png]
273 +
274 +
| Configuration name | Description                                                                                                                                                                         |
275 +
|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
276 +
| Run Plugin         | Runs [`:runIde`][gh:intellij-platform-gradle-plugin-runIde] IntelliJ Platform Gradle Plugin task. Use the *Debug* icon for plugin debugging.                                        |
277 +
| Run Tests          | Runs [`:check`][gradle:lifecycle-tasks] Gradle task.                                                                                                                                |
278 +
| 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. |
279 +
280 +
> [!NOTE]
281 +
> You can find the logs from the running task in the `idea.log` tab.
282 +
>
283 +
> ![Run/Debug configuration logs][file:run-logs.png]
284 +
285 +
286 +
## Continuous integration
287 +
288 +
Continuous integration depends on [GitHub Actions][gh:actions], a set of workflows that make it possible to automate your testing and release process.
289 +
Thanks 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).
290 +
291 +
> [!NOTE]
292 +
> 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`.
293 +
294 +
295 +
In the `.github/workflows` directory, you can find definitions for the following GitHub Actions workflows:
296 +
297 +
- [Build](.github/workflows/build.yml)
298 +
  - Triggered on `push` and `pull_request` events.
299 +
  - Builds the plugin with the `buildPlugin` Gradle task and uploads the plugin ZIP as a workflow artifact.
300 +
  - Runs the `check` Gradle task in a dedicated test job.
301 +
  - Runs the `verifyPlugin` Gradle task in a dedicated verification job.
302 +
  - Prepares a draft release of the GitHub Releases page for manual verification.
303 +
- [Release](.github/workflows/release.yml)
304 +
  - Triggered on `prereleased` and `released` events.
305 +
  - Updates `CHANGELOG.md` with the published release notes when a release body is provided.
306 +
  - Signs the plugin with a provided certificate before publishing.
307 +
  - Publishes the plugin to JetBrains Marketplace using the provided `PUBLISH_TOKEN`.
308 +
  - Uploads the built plugin distribution as a GitHub release asset.
309 +
  - Creates a pull request with the patched changelog when needed.
310 +
- [Template Cleanup](.github/workflows/template-cleanup.yml)
311 +
  - Triggered once on the `push` event when a new template-based repository has been created.
312 +
  - Overrides the scaffold with files from the `.github/template-cleanup` directory.
313 +
  - Overrides JetBrains-specific sentences or package names with ones specific to the target repository.
314 +
  - Removes redundant files.
315 +
316 +
All the workflow files include inline documentation, so it's a good idea to take a look through their sources.
317 +
318 +
### Dependencies management
319 +
320 +
This template keeps dependency management explicit and local to the Gradle files that use it:
321 +
- [`settings.gradle.kts`][file:settings.gradle.kts] declares Gradle plugin versions and repositories.
322 +
- [`build.gradle.kts`][file:build.gradle.kts] declares the target IntelliJ Platform version and project dependencies.
323 +
- [`gradle.properties`][file:gradle.properties] stores repository-specific metadata shared by the build and CI workflows.
324 +
325 +
> [!NOTE]
326 +
> To add a regular library dependency, declare it directly in the `dependencies { ... }` block:
327 +
>
328 +
> ```kotlin
329 +
> dependencies {
330 +
>   implementation("group:artifact:version")
331 +
> }
332 +
> ```
333 +
>
334 +
> 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].
335 +
336 +
Keeping 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].
337 +
338 +
Dependabot is a bot provided by GitHub that checks build configuration files for outdated or insecure dependencies.
339 +
When an update is available, it creates a new pull request providing [the proper change][gh:dependabot-pr].
340 +
341 +
> [!NOTE]
342 +
> Dependabot supports [Gradle Wrapper updates][gh:dependabot-supported-ecosystems].
343 +
> To update Gradle manually, check the [Gradle Releases][gradle:releases] page and run
344 +
> ```bash
345 +
> ./gradlew wrapper --gradle-version <version> && ./gradlew wrapper
346 +
> ```
347 +
348 +
### Changelog maintenance
349 +
350 +
When releasing an update, it is essential to let your users know what the new version offers.
351 +
The best way to do this is to provide release notes.
352 +
353 +
The changelog is a curated list that contains information about any new features, fixes, and deprecations.
354 +
When they're provided, these lists are available in a few different places:
355 +
- the [CHANGELOG.md](./CHANGELOG.md) file,
356 +
- the [Releases page][gh:releases],
357 +
- the *What's new* section of the JetBrains Marketplace Plugin page,
358 +
- and inside the Plugin Manager's item details.
359 +
360 +
There are many methods for handling the project's changelog.
361 +
The one used in the current template project is the [Keep a Changelog][keep-a-changelog] approach.
362 +
363 +
The [Gradle Changelog Plugin][gh:gradle-changelog-plugin] takes care of propagating information provided within the [CHANGELOG.md](./CHANGELOG.md) to the [IntelliJ Platform Gradle Plugin][gh:intellij-platform-gradle-plugin].
364 +
You only have to take care of writing down the actual changes in proper sections of the `[Unreleased]` section.
365 +
366 +
You start with an almost empty changelog:
367 +
368 +
```
369 +
# YourPlugin Changelog
370 +
371 +
## [Unreleased]
372 +
### Added
373 +
- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template)
374 +
```
375 +
376 +
Now 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).
377 +
378 +
When 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.
379 +
GitHub Actions will swap it and provide you with an empty section for the next release so that you can proceed with your development:
380 +
381 +
```
382 +
# YourPlugin Changelog
383 +
384 +
## [Unreleased]
385 +
386 +
## [0.0.1]
387 +
### Added
388 +
- An awesome feature
389 +
- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template)
390 +
391 +
### Fixed
392 +
- One annoying bug
393 +
```
394 +
395 +
To 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.
396 +
397 +
### Release flow
398 +
399 +
The release process depends on the workflows already described above.
400 +
When your main branch receives a new pull request or a direct push, the [Build](.github/workflows/build.yml) workflow runs multiple tests on your plugin and prepares a draft release.
401 +
402 +
![Release draft][file:draft-release.png]
403 +
404 +
The draft release is a working copy of a release, which you can review before publishing.
405 +
It uses the current plugin version from [`gradle.properties`][file:gradle.properties] as both the title and git tag, for example, `0.0.1`.
406 +
The changelog is provided automatically using the [gradle-changelog-plugin][gh:gradle-changelog-plugin].
407 +
The built plugin archive is uploaded as a workflow artifact during the Build run rather than attached to the draft release itself.
408 +
Every new Build overrides the previous draft to keep your *Releases* page clean.
409 +
410 +
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.
411 +
Next, it will notify users who are *watching* the repository, triggering the final [Release](.github/workflows/release.yml) workflow.
412 +
413 +
### Plugin signing
414 +
415 +
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.
416 +
417 +
JetBrains Marketplace signing is designed to ensure that plugins aren't modified over the course of the publishing and delivery pipeline.
418 +
419 +
The current template keeps signing configuration out of `build.gradle.kts` and relies on the standard environment variables consumed by the IntelliJ Platform Gradle Plugin.
420 +
That allows you to sign and publish your plugin from both the Continuous Integration (CI) and local environments without checking secrets into VCS.
421 +
422 +
To find out how to generate signing certificates, check the [Plugin Signing][docs:plugin-signing] section in the IntelliJ Platform Plugin SDK documentation.
423 +
424 +
### Publishing the plugin
425 +
426 +
> [!TIP]
427 +
> Make sure to follow all guidelines listed in [Publishing a Plugin][docs:publishing] to follow all recommended and required steps.
428 +
429 +
Releasing a plugin to [JetBrains Marketplace](https://plugins.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].
430 +
In addition, the [Release](.github/workflows/release.yml) workflow automates this process by running the task when a new release appears in the GitHub Releases section.
431 +
432 +
> [!NOTE]
433 +
> 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].
434 +
435 +
The authorization process relies on the `PUBLISH_TOKEN` secret environment variable, specified in the `⚙️ Settings > Secrets and variables > Actions` section of your project repository.
436 +
437 +
You can get that token in your JetBrains Marketplace profile dashboard in the [My Tokens][jb:my-tokens] tab.
438 +
439 +
> [!WARNING]
440 +
> 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.
441 +
> Please follow the [Publishing a Plugin][docs:publishing] instructions.
442 +
443 +
444 +
## FAQ
445 +
446 +
### How to use Java in my project?
447 +
448 +
Java language is supported by default along with Kotlin.
449 +
Initially, the `/src/main/kotlin` directory is available with minimal examples.
450 +
You can still replace it or add the `/src/main/java` directory to start working with Java language instead.
451 +
452 +
### How to disable *tests* or *build* job using the `[skip ci]` commit message?
453 +
454 +
Since February 2021, GitHub Actions [has supported the skip CI feature][github-actions-skip-ci].
455 +
If the message contains one of the following strings: `[skip ci]`, `[ci skip]`, `[no ci]`, `[skip actions]`, or `[actions skip]` – workflows will not be triggered.
456 +
457 +
### Why does the draft release no longer contain a built plugin artifact?
458 +
459 +
All binaries created by the workflows are still available as workflow artifacts together with failed test reports or Plugin Verifier results.
460 +
That approach gives more possibilities for testing and debugging pre-releases, for example, in your local environment.
461 +
462 +
## Useful links
463 +
464 +
- [IntelliJ Platform Plugin SDK][docs]
465 +
- [IntelliJ Platform Gradle Plugin Documentation][gh:intellij-platform-gradle-plugin-docs]
466 +
- [IntelliJ Platform Explorer][jb:ipe]
467 +
- [JetBrains Marketplace Quality Guidelines][jb:quality-guidelines]
468 +
- [IntelliJ Platform UI Guidelines][jb:ui-guidelines]
469 +
- [JetBrains Marketplace Paid Plugins][jb:paid-plugins]
470 +
- [Kotlin UI DSL][docs:kotlin-ui-dsl]
471 +
- [IntelliJ SDK Code Samples][gh:code-samples]
472 +
- [JetBrains Platform Slack][jb:slack]
473 +
- [JetBrains Platform Twitter][jb:twitter]
474 +
- [IntelliJ IDEA Open API and Plugin Development Forum][jb:forum]
475 +
- [Keep a Changelog][keep-a-changelog]
476 +
- [GitHub Actions][gh:actions]
477 +
478 +
[docs]: https://plugins.jetbrains.com/docs/intellij?from=IJPluginTemplate
479 +
[docs:intro]: https://plugins.jetbrains.com/docs/intellij/intellij-platform.html?from=IJPluginTemplate
480 +
[docs:kotlin-ui-dsl]: https://plugins.jetbrains.com/docs/intellij/kotlin-ui-dsl-version-2.html?from=IJPluginTemplate
481 +
[docs:kotlin]: https://plugins.jetbrains.com/docs/intellij/using-kotlin.html?from=IJPluginTemplate
482 +
[docs:kotlin-stdlib]: https://plugins.jetbrains.com/docs/intellij/using-kotlin.html?from=IJPluginTemplate#kotlin-standard-library
483 +
[docs:plugin.xml]: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html?from=IJPluginTemplate
484 +
[docs:publishing]: https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate
485 +
[docs:using-gradle]: https://plugins.jetbrains.com/docs/intellij/developing-plugins.html?from=IJPluginTemplate
486 +
[docs:plugin-signing]: https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate
487 +
[docs:project-structure-settings]: https://www.jetbrains.com/help/idea/project-settings-and-structure.html
488 +
[docs:testing-plugins]: https://plugins.jetbrains.com/docs/intellij/testing-plugins.html?from=IJPluginTemplate
489 +
[docs:integration-tests]: https://plugins.jetbrains.com/docs/intellij/integration-tests.html?from=IJPluginTemplate
490 +
[docs:integration-tests-ui]: https://plugins.jetbrains.com/docs/intellij/integration-tests-ui.html?from=IJPluginTemplate
491 +
492 +
[file:build.gradle.kts]: ./build.gradle.kts
493 +
[file:draft-release.png]: ./.github/readme/draft-release.png
494 +
[file:get-from-version-control]: ./.github/readme/get-from-version-control.png
495 +
[file:gradle.properties]: ./gradle.properties
496 +
[file:intellij-platform-plugin-template-dark]: ./.github/readme/intellij-platform-plugin-template-dark.svg#gh-dark-mode-only
497 +
[file:intellij-platform-plugin-template-light]: ./.github/readme/intellij-platform-plugin-template-light.svg#gh-light-mode-only
498 +
[file:project-structure-sdk.png]: ./.github/readme/project-structure-sdk.png
499 +
[file:plugin.xml]: ./src/main/resources/META-INF/plugin.xml
500 +
[file:run-debug-configurations.png]: ./.github/readme/run-debug-configurations.png
501 +
[file:run-logs.png]: ./.github/readme/run-logs.png
502 +
[file:settings-secrets.png]: ./.github/readme/settings-secrets.png
503 +
[file:settings.gradle.kts]: ./settings.gradle.kts
504 +
[file:template_cleanup.yml]: ./.github/workflows/template-cleanup.yml
505 +
[file:use-this-template.png]: ./.github/readme/use-this-template.png
506 +
507 +
[gh:actions]: https://docs.github.com/actions
508 +
[gh:build]: https://github.com/JetBrains/intellij-platform-plugin-template/actions?query=workflow%3ABuild
509 +
[gh:code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples
510 +
[gh:dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates
511 +
[gh:dependabot-pr]: https://github.com/JetBrains/intellij-platform-plugin-template/pull/73
512 +
[gh:dependabot-supported-ecosystems]: https://docs.github.com/en/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories#gradle
513 +
[gh:gradle-changelog-plugin]: https://github.com/JetBrains/gradle-changelog-plugin
514 +
[gh:intellij-platform-gradle-plugin]: https://github.com/JetBrains/intellij-platform-gradle-plugin
515 +
[gh:intellij-platform-gradle-plugin-docs]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin.html
516 +
[gh:intellij-platform-gradle-plugin-runIde]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-tasks.html#runIde
517 +
[gh:intellij-platform-gradle-plugin-verifyPlugin]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-tasks.html#verifyPlugin
518 +
[gh:releases]: https://github.com/JetBrains/intellij-platform-plugin-template/releases
519 +
520 +
[gradle]: https://gradle.org
521 +
[gradle:build-cache]: https://docs.gradle.org/current/userguide/build_cache.html
522 +
[gradle:configuration-cache]: https://docs.gradle.org/current/userguide/configuration_cache.html
523 +
[gradle:kotlin-dsl]: https://docs.gradle.org/current/userguide/kotlin_dsl.html
524 +
[gradle:lifecycle-tasks]: https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks
525 +
[gradle:releases]: https://gradle.org/releases
526 +
527 +
[jb:github]: https://github.com/JetBrains/.github/blob/main/profile/README.md
528 +
[jb:download-ij]: https://www.jetbrains.com/idea/download
529 +
[jb:forum]: https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development
530 +
[jb:ipe]: https://jb.gg/ipe
531 +
[jb:my-tokens]: https://plugins.jetbrains.com/author/me/tokens
532 +
[jb:paid-plugins]: https://plugins.jetbrains.com/docs/marketplace/paid-plugins-marketplace.html
533 +
[jb:quality-guidelines]: https://plugins.jetbrains.com/docs/marketplace/quality-guidelines.html
534 +
[jb:slack]: https://plugins.jetbrains.com/slack
535 +
[jb:twitter]: https://twitter.com/JBPlatform
536 +
[jb:ui-guidelines]: https://jetbrains.github.io/ui
537 +
538 +
[github-actions-skip-ci]: https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/
539 +
[keep-a-changelog]: https://keepachangelog.com
540 +
[keep-a-changelog-how]: https://keepachangelog.com/en/1.0.0/#how
541 +
[semver]: https://semver.org