From 8e53844818a4a18760f7ffc08bef87a2a7358719 Mon Sep 17 00:00:00 2001 From: stud_i_sram Date: Thu, 18 Jun 2026 11:05:57 +0300 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D1=82?= =?UTF-8?q?=D1=8C=20README=20=D0=B8=20CHANGELOG,=20=D0=B2=D1=8B=D0=BF?= =?UTF-8?q?=D1=83=D1=81=D1=82=D0=B8=D1=82=D1=8C=20=D0=B2=D0=B5=D1=80=D1=81?= =?UTF-8?q?=D0=B8=D1=8E=201.0.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Заменить шаблонную документацию на описание SSH Remote Sync и зафиксировать первый стабильный релиз. Co-authored-by: Cursor --- CHANGELOG.md | 1017 +-------------------------------------------- README.md | 573 ++++--------------------- gradle.properties | 2 +- 3 files changed, 97 insertions(+), 1495 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f823ea3..99240d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,1007 +1,32 @@ - +# Changelog -# IntelliJ Platform Plugin Template Changelog +Все значимые изменения в проекте документируются в этом файле. -## [Unreleased] +Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.1.0/), +версионирование следует [Semantic Versioning](https://semver.org/lang/ru/). + +## [1.0.0] - 2026-06-18 + +Первый стабильный релиз. ### Added -- Add operator function for resource bundle key access in `MyBundle` +- Менеджер SSH-серверов в настройках IDE (**File → Settings → SSH Remote Project**) +- Хранение паролей в системном хранилище IDE (`PasswordSafe`) +- Скачивание удалённого проекта и открытие его как локального +- Автосинхронизация файлов при сохранении, создании и удалении +- Ручное обновление проекта с сервера (**Refresh from Server**) +- Переключение между несколькими удалёнными серверами +- Выполнение произвольных команд на сервере через SSH +- Встроенный SSH-терминал с автоматическим переходом в папку проекта +- Локальный кэш проектов в `~/ssh-remote-projects///` +- Меню **Tools → SSH Remote Manager** со всеми действиями плагина ### Changed -- Upgrade Gradle Wrapper to `9.5.0` -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.16.0` -- Dependencies - upgrade IntelliJ IDEA to `2025.2.6.2` -- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v7` -- Dependencies (GitHub Actions) - upgrade `gradle/actions/setup-gradle` to `v6` -- GitHub Actions - simplify plugin artifact upload in GitHub Actions workflow - -### Removed - -- Remove changelog configuration from `build.gradle.kts` as it is preconfigured now in the IntelliJ Platform Gradle Plugin -- Remove `intellijPlatform.pluginConfiguration.description` default configuration from `build.gradle.kts`. -- Remove `run-ui-tests.yml` workflow for outdated UI testing setup +- Алгоритм формирования локального пути к проекту +- Логика сохранения пароля при редактировании существующего сервера (пустое поле не затирает сохранённый пароль) ### Fixed -- Update Run Plugin configuration to fix sandbox log file path -- Remove `settings.gradle.kts` for cleanup of unused project configuration. -- Update Run Plugin configuration to fix sandbox log file path - -## [2.5.0] - 2026-04-17 - -### Changed - -- Migrate IntelliJ Platform repository configuration to `settings.gradle.kts` -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.14.0` -- Update `group` property in `gradle.properties` and remove redundant `pluginGroup` configuration from `build.gradle.kts` -- Update `version` property in `gradle.properties` and remove redundant `pluginVersion` configuration from `build.gradle.kts` -- Inline `junit` dependency version in `build.gradle.kts` and remove it from `libs.versions.toml`. -- Remove `platformVersion` property and inline its value in `build.gradle.kts` for cleaner configuration. -- Remove `libs.versions.toml` and inline plugin versions in build scripts for simpler configuration. - -### Removed - -- Remove (empty) plugin and module dependency configurations from `build.gradle.kts` and `gradle.properties`. -- Remove `opentest4j` dependency from `build.gradle.kts` and `libs.versions.toml`, redundant since IntelliJ Platform 251+ -- Remove `gradleVersion` property and wrapper configuration as Gradle Wrapper should be updated with `./gradlew wrapper --gradle-version=9.4.1 && ./gradlew wrapper` -- Remove Qodana configuration, dependencies, and related workflow steps. -- Remove Kover configuration, dependencies, and related workflow steps. -- Remove redundant Kotlin JVM toolchain configuration from `build.gradle.kts` -- Remove redundant `intellijPlatform.pluginConfiguration.ideaVersion.sinceBuild` configuration from `build.gradle.kts` -- Remove redundant `pluginSinceBuild` property from `gradle.properties` -- Remove redundant `intellijPlatform.signing` configuration from `build.gradle.kts` -- Remove redundant `intellijPlatform.publishing.token` configuration from `build.gradle.kts` -- Remove redundant `intellijPlatform.pluginVerification` configuration from `build.gradle.kts` -- Remove redundant `java` plugin declaration from `build.gradle.kts` -- Remove `pluginVersion` configuration from `build.gradle.kts`. -- Remove `pluginName` property from `gradle.properties` and `build.gradle.kts` as it is already set in the `plugin.xml` -- Remove `intellijPlatform.publishing.channels` configuration from `build.gradle.kts`. -- Remove `runIdeForUiTests` obsolete task from `build.gradle.kts`. - -## [2.4.1] - 2026-03-20 - -### Fixed - -- GitHub Actions: handle empty releases list in draft cleanup step using `xargs -r` - -### Changed - -- Upgrade Gradle Wrapper to `9.4.1` -- Set empty `versionPrefix` for changelog in Gradle build file. -- Update `platformVersion` to `2025.2.6.1` -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.13.1` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.3.20` -- Dependencies - upgrade `org.jetbrains.qodana` to `2025.3.2` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.9.7` -- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v6` -- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v6` -- GitHub Actions: Setup Java and Gradle actions for the `releaseDraft` build step - -## [2.4.0] - 2025-11-25 - -### Fixed - -- Use the GitHub event release body for a condition when creating the Release Draft - -### Changed - -- Use `intellijIdea(version)` dependency helper instead of `create(type, version)` -- Upgrade Gradle Wrapper to `9.2.1` -- Update `platformVersion` to `2025.2.5` -- Change since build to `252` (2025.2) -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.10.5` -- Dependencies - upgrade `org.jetbrains.changelog` to `2.5.0` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.2.21` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.9.3` -- Dependencies - upgrade `org.jetbrains.qodana` to `2025.2.2` -- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v5` -- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `v5` -- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v5` -- Dependencies (GitHub Actions) - upgrade `gradle/actions/setup-gradle` to `v5` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2025.2.2` - -### Removed - -- Remove the `platformType` Gradle property - -## [2.3.1] - 2025-08-09 - -### Added - -- Add `platformBundledModules` to `gradle.properties` along with `bundledModules()` helper to the Gradle build file - -### Changed - -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.7.1` - -### Fixed - -- GitHub: Fixed the missing `$RELEASE_NOTE ` parent directory in the Release workflow - -## [2.3.0] - 2025-08-09 - -### Added - -- Added `.DS_Store` directory to `.gitignore` - -### Changed - -- GitHub Actions: simplify changelog handling -- Dependencies - upgrade `org.jetbrains.changelog` to `2.4.0` - -## [2.2.0] - 2025-08-05 - -### Added - -- GitHub Actions: set Gradle cache to read-only for non-build jobs -- GitHub Actions: add `jlumbroso/free-disk-space` action to build related steps to maximize build environment storage -- Added `.kotlin` directory to `.gitignore` for Kotlin 2.0 - -### Removed - -- Remove `pluginUntilBuild` obsolete property -- GitHub Actions: Remove obsolete Plugin Verifier cache directory configuration - -### Changed - -- Upgrade Gradle Wrapper to `8.14.3` -- Update `platformVersion` to `2024.3.6` -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.7.0` -- Dependencies - upgrade `org.jetbrains.changelog` to `2.3.0` -- Dependencies - upgrade `org.jetbrains.qodana` to `2025.1.1` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.2.0` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2025.1.1` -- Dependencies (GitHub Actions) - upgrade `ad-m/github-push-action` to `v0.8.0` -- Dependencies (GitHub Actions) - upgrade `jlumbroso/free-disk-space` to `v1.3.1` -- Gradle - upgrade `org.gradle.toolchains.foojay-resolver-convention` to `1.0.0` -- Change since build to `243` (2024.3) -- Update codecov configuration based on new required upload token - -## [2.1.0] - 2025-03-28 - -### Added - -- Example code – `ProjectActivity` -- 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) - -### Removed - -- Example code – `MyApplicationActivationListener` -- Remove redundant IntelliJ Platform dependency helpers: `instrumentationTools()`, `pluginVerifier()`, `zipSigner()` -- GitHub Actions: Remove `gradle/actions/wrapper-validation` because validation is performed by default in `gradle/actions/setup-gradle@v4` - -### Changed - -- Change JVM version to `21` -- Upgrade Gradle Wrapper to `8.13` -- Update `platformVersion` to `2024.2.5` -- Change since/until build to `242-252.*` (2024.2-2025.2.*) -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.5.0` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.1.20` -- Dependencies - upgrade `org.jetbrains.qodana` to `2024.3.4` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.9.1` -- Dependencies (GitHub Actions) - upgrade `gradle/actions/wrapper-validation` to `v4` -- Dependencies (GitHub Actions) - upgrade `codecov/codecov-action` to `v5` - -## [2.0.2] - 2024-10-07 - -### Changed - -- Upgrade Gradle Wrapper to `8.10.2` -- Update `platformVersion` to `2023.3.8` -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.1.0` -- Dependencies - upgrade `org.jetbrains.qodana` to `2024.2.3` -- Dependencies (GitHub Actions) - upgrade `gradle/actions/setup-gradle` to `v4` -- Add back the `org.gradle.toolchains.foojay-resolver-convention` Gradle settings plugin - -### Fixed - -- Fixed _Run Plugin_ run configuration logs location - -### Removed - -- Removed _Run Qodana_ and _Run UI for UI Tests_ run configurations - -## [2.0.1] - 2024-08-09 - -### Changed - -- Update `platformVersion` to `2023.3.7` -- Change since/until build to `233-242.*` (2023.3-2024.2.*) -- Cleanup registering the `runIdeForUiTests` task -- Dependencies - upgrade `org.jetbrains.intellij.platform` to `2.0.1` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.25` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.8.3` -- Dependencies - upgrade `org.jetbrains.qodana` to `2024.1.9` - -## [2.0.0] - 2024-07-30 - -### Changed - -- Migrate to [IntelliJ Platform Gradle Plugin 2.0](https://blog.jetbrains.com/platform/2024/07/intellij-platform-gradle-plugin-2-0/). - -## [1.14.2] - 2024-07-12 - -### Changed - -- Upgrade Gradle Wrapper to `8.9` - -### Removed - -- Remove default plugin icon (`pluginIcon.svg`) - -## [1.14.1] - 2024-06-19 - -### Changed - -- Update `platformVersion` to `2023.2.7` -- Upgrade Gradle Wrapper to `8.8` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.17.4` -- Dependencies - downgrade `org.jetbrains.kotlin.jvm` to `1.9.24` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.8.1` - -## [1.14.0] - 2024-05-30 - -### Changed - -- Update `platformVersion` to `2023.2.6` -- Change since/until build to `232-242.*` (2023.2-2024.2.*) -- Upgrade Gradle Wrapper to `8.7` -- Update Kover configuration -- Replace `org.jetbrains:annotations` library with an `com.example:exampleLibrary` placeholder -- Dependencies - upgrade `org.jetbrains.intellij` to `1.17.3` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `2.0.0` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.8.0` -- Dependencies - upgrade `org.jetbrains.qodana` to `2024.1.5` -- Dependencies (GitHub Actions) - replace `gradle/wrapper-validation-action@v2` with `gradle/actions/wrapper-validation@v3` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2024.1.5` -- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `v4` - -## [1.13.0] - 2024-03-11 - -### Changed - -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.23` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.6` -- Dependencies - upgrade `org.jetbrains.qodana` to `2023.3.2` -- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `4` -- Dependencies (GitHub Actions) - upgrade `codecov/codecov-action` to `4` -- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `2` -- Dependencies (GitHub Actions) - upgrade `actions/cache` to `4` -- Gradle - upgrade `org.gradle.toolchains.foojay-resolver-convention` to `0.8.0` -- Gradle - cleanup the `jvmToolchain` setup -- Run Configurations - `Run Qodana` runs the `qodanaScan` Gradle task - -### Fixed - -- Fixed calculation of the plugin publication channel -- Run Configurations - `Run Tests` uses the `RunAsTest` IDE feature -- Replace the whole `IntelliJ Platform Plugin Template` with the new project name when running the GitHub Actions Cleanup workflow - -### Removed - -- GitHub Actions: Remove the `Setup Java` step from the `releaseDraft` build step -- Gradle - Removed Qodana Gradle Plugin configuration to rely on defaults - -## [1.12.0] - 2024-02-20 - -### Added - -- GitHub Actions: Reduce the number of concurrent builds - -### Changed - -- Change since/until build to `223-241.*` (2022.3-2024.1.*) -- Upgrade Gradle Wrapper to `8.6` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.17.2` -- Dependencies (GitHub Actions) - upgrade `gradle/gradle-build-action@v2` to `gradle/actions/setup-gradle@v3` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.3.1` - -### Fixed - -- Adjusted obtaining the value for `publishPlugin.channels` property in `build.gradle.kts` -- Fixed bash variable access in the Create Release Draft step. - -### Removed - -- Remove Gradle Kotlin DSL Lazy Property Assignment because it's default now - -## [1.11.3] - 2023-12-01 - -### Changed - -- Upgrade Gradle Wrapper to `8.5` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.16.1` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.21` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.5` -- Dependencies - upgrade `annotations` to `24.1.0` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.8` -- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `4` - -## [1.11.2] - 2023-10-06 - -### Changed - -- Upgrade Gradle Wrapper to `8.4` -- Gradle - use JetBrains Runtime -- Gradle - upgrade `org.gradle.toolchains.foojay-resolver-convention` to `0.7.0` -- Change since/until build to `223-233.*` (2022.3-2023.3.*) -- Dependencies - upgrade `org.jetbrains.intellij` to `1.16.0` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.10` -- Dependencies - upgrade `org.jetbrains.changelog` to `2.2.0` -- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `4` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.6` - -## [1.11.1] - 2023-08-17 - -### Fixed - -- GitHub Actions: publish workflow fails due to the existing `release changelog` label - -### Changed - -- Upgrade Gradle Wrapper to `8.3` - -## [1.11.0] - 2023-08-07 - -### Changed - -- GitHub Actions: move the `Maximize Build Space` step from the `Build` job to `Inspect code` and `Verify plugin` jobs -- Update `platformVersion` to `2022.3.3` -- Change since/until build to `223-232.*` (2022.3-2023.2.*) -- `MyBundle`: remove `SpreadOperator` suppression -- `MyBundle.properties`: remove unused `name` property - -## [1.10.0] - 2023-08-04 - -### Added - -- [Foojay Toolchains Plugin](https://github.com/gradle/foojay-toolchains) integration -- GitHub Actions: set `gradle-home-cache-cleanup: true` flag to the Gradle Build Action -- GitHub Actions: use `jlumbroso/free-disk-space` to free disk space - -### Changed - -- GitHub Actions: rearrange the Build workflow -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.3` -- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.1.0` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.2.1` - -### Fixed - -- GitHub Actions: Fixed Kover report path when uploading the code coverage report - -## [1.9.0] - 2023-07-11 - -### Added - -- GitHub Actions — use Java `17` explicitly - -### Changed - -- Upgrade Gradle Wrapper to `8.2.1` -- Dependencies — upgrade `org.jetbrains.changelog` to `2.1.2` -- GitHub Actions — rearrange the Build workflow - -### Fixed - -- Fixed copying files issue when running the `Template Cleanup` workflow - -## [1.8.0] - 2023-07-07 - -### Changed - -- GitHub Actions: Build workflow refactoring -- Upgrade Gradle Wrapper to `8.2` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.9.0` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.15.0` -- Dependencies - upgrade `org.jetbrains.changelog` to `2.1.1` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.2` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.1.5` - -### Fixed - -- Dependabot workflow points to `next` branch in a newly created project - -### Removed - -- Removed workaround for Kotlin Compiler `OutOfMemoryError` as the issue is gone with Kotlin `1.9.0` - -## [1.7.0] - 2023-06-07 - -### Added - -- GitHub Actions — enable caching -- Specify `projectJDK: 17` in `qodana.yml` -- Specify `linter` property in `qodana.yml` - -### Changed - -- Use Java `17` for JVM Toolchain -- Change since/until build to `222-232.*` (2022.2–2023.2.*) -- Dependencies - upgrade `org.jetbrains.intellij` to `1.14.1` -- Dependencies - upgrade `org.jetbrains.changelog` to `2.1.0` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.21` -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.7.1` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2023.1.0` -- Upgrade Gradle Wrapper to `8.1.1` -- GitHub Actions — switch to Java 17 -- Update Run Configuration entries -- Adjust Kover configuration - -### Fixed - -- Example code — Fixed deprecated usage of `ContentFactory` in `MyToolWindowFactory` -- Example code — Migrate from the deprecated `FrameStateListener.onFrameActivated()` to `ApplicationActivationListener.applicationActivated(IdeFrame)` - -### Removed - -- Remove `gradleJvm` property from the `.idea/gradle.xml` file -- GitHub Actions — Drop unused `name` output from the `Build` workflow - -## [1.6.0] - 2023-04-13 - -### Added - -- Temporary workaround for Kotlin Compiler `OutOfMemoryError` -> https://jb.gg/intellij-platform-kotlin-oom -- Gradle version catalog integration -- Gradle Kotlin DSL Lazy Property Assignment -- Enable Gradle Build Cache - -### Changed - -- Dependencies - upgrade `org.jetbrains.intellij` to `1.13.3` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.20` -- Upgrade Gradle Wrapper to `8.1` -- Remove `UnusedProperty` suppression in `gradle.properties` file -- Rename `org.gradle.unsafe.configuration-cache` to `org.gradle.configuration-cache` in `gradle.properties` - -## [1.5.0] - 2023-03-10 - -### Added - -- Migrate to Gradle Provider API improving configuration cache compatibility -- Example code - `FrameStateListener` application listener -- Example code - `MyToolWindowFactory` tool window basic implementation - -### Changed - -- Update `platformVersion` to `2022.1.4` -- Change since/until build to `221-231.*` (2022.1-2023.1.*) -- Example code - registered project service changed into a lightweight one -- GitHub Actions — pass changelog release notes as a multi-line content -- GitHub Actions — provide `plugin.verifier.home.dir` variable as a system property instead of project property -- Template Cleanup: remove default `pluginIcon.svg` icon -- Upgrade Gradle Wrapper to `8.0.2` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.10` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.13.2` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.3.4` -- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.0.6` - -### Fixed - -- Resolving the content for the `patchPluginXML.changeNotes` property - -### Removed - -- Example code — application service -- Example code — deprecated `ProjectManagerListener` application listener - -## [1.4.0] - 2023-01-13 - -### Changed - -- GitHub Actions — use `GITHUB_OUTPUT` environment file instead of `::set-output`. -- Upgrade Gradle Wrapper to `7.6` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.8.0` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.12.0` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.3.0` - -### Fixed - -- Fallback to the unreleased change notes when the plugin in current was not released yet - -## [1.3.0] - 2022-11-17 - -### Added - -- [Kover](https://github.com/Kotlin/kotlinx-kover) integration -- Enable [Gradle Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html) in `gradle.properties` -- GitHub Actions — mark the pull request created with _Publish Plugin_ workflow with `release changelog` label -- GitHub Actions — send code coverage reports to [CodeCov](https://codecov.io) -- Dependencies - upgrade `org.jetbrains.kotlinx.kover` to `0.6.1` - -### Changed - -- Update `changelog` extension configuration in `build.gradle.kts` file -- Update `pluginUntilBuild` to include `223.*` (2022.3.*) -- Use `kotlin.jvmToolchain(11)` shorthand in Gradle configuration -- Dependencies - upgrade `org.jetbrains.intellij` to `1.10.0` -- Dependencies - upgrade `org.jetbrains.changelog` to `2.0.0` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.7.21` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.2.3` -- Dependencies (GitHub Actions) - upgrade `gradle/wrapper-validation-action` to `v1.0.5` -- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `v3` -- Use `file` instead of `projectDir.resolve` in Gradle configuration file - -### Fixed - -- Update broken link in `gradle.properties` -- GitHub Actions — use `$BRANCH` for creating changelog pull request - -## [1.2.0] - 2022-08-07 - -### Added - -- Use JVM toolchain for configuring source/target compilation compatibility -- Make sure GitHub Actions release jobs have write permissions -- Example implementation: Add `TODO()` with a hint to remove stale sample code -- Exclude `.qodana` directory from Qodana analysis -- Maximize disk space on GitHub Actions - -### Changed - -- Upgrade Gradle Wrapper to `7.5.1` -- Update `platformVersion` to `2021.3.3` -- Change since/until build to `213-222.*` (2021.3-2022.2) -- Dependencies - upgrade `org.jetbrains.intellij` to `1.8.0` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.7.10` -- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `3` -- Dependencies (GitHub Actions) - upgrade `actions/cache` to `3` -- Dependencies (GitHub Actions) - upgrade `actions/setup-java` to `3` -- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `3` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `v2022.2.1` - -### Fixed - -- Pass Plugin Signing secrets as environment variables in the Release workflow - -### Removed - -- Removed Gradle caching from GitHub Actions - -## [1.1.2] - 2022-02-11 - -### Changed - -- Update `platformVersion` to `2021.1.3` for compatibility with Apple M1 -- Change since/until build to `211-213.*` (2021.1-2021.3) -- Upgrade Gradle Wrapper to `7.4` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.4.0` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `4.2.5` - -## [1.1.1] - 2022-01-24 - -### Changed - -- GitHub Actions — fixed duplicated `.zip` extension in artifact file's name of the build flow -- Upgrade Gradle Wrapper to `7.3.3` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.3.1` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.6.10` -- Dependencies (GitHub Actions) - upgrade `JetBrains/qodana-action` to `4.2.3` -- Dependencies (GitHub Actions) - upgrade `actions/cache` to `2.1.7` - -## [1.1.0] - 2021-11-16 - -### Added - -- GitHub Actions: Collect Qodana/Tests/Plugin Verifier results as artifacts - -### Changed - -- Dependencies - upgrade `org.jetbrains.intellij` to `1.3.0` -- Dependencies - upgrade `org.jetbrains.changelog` to `1.3.1` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.6.0` -- Dependencies (GitHub Actions) - upgrade `jtalk/url-health-check-action` to `2` -- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `2.3.5` -- GitHub Actions general performance refactoring -- GitHub Actions — prepare plugin archive content to be archived at once -- GitHub Actions — patch changelog only if change notes are provided -- Update `pluginUntilBuild` to include `213.*` (2021.3.*) -- Upgrade Gradle Wrapper to `7.3` - -### Fixed - -- Fixed passing change notes from `CHANGELOG.md` to the Release Draft -- Fixed passing updated change notes from the Release Draft to `patchChangelog` Gradle task -- Fixed `QODANA_SHOW_REPORT` environment variable resolving for Gradle `6.x` - -### Removed - -- Removed the `pluginVerifierIdeVersions` configuration to use a default IDEs list provided by the `listProductsReleases` task for `runPluginVerifier` -- Removed `platformDownloadSources` from Gradle configuration to use default value -- Removed `updateSinceUntilBuild.set(true)` from Gradle configuration to use default value - -## [1.0.0] - 2021-09-07 - -### Added - -- Plugin Signing -- Qodana integration -- Functional tests -- Compatibility with Java 11 -- `Run Qodana` and `Run IDE for UI Tests` run configurations -- Use Gradle `wrapper` task to handle Gradle updates -- JVM compatibility version extracted to `gradle.properties` file -- Suppress `UnusedProperty` inspection for the `kotlin.stdlib.default.dependency` in `gradle.properties` - -### Changed - -- GitHub Actions: Switch to Java 11 -- GitHub Actions: Update Build and Release flows -- GitHub Actions: Use Gradle cache provided with `actions/setup-java` -- Update `pluginVerifierIdeVersions` to `2020.3.4, 2021.1.3, 2021.2.1` -- Change since/until build to `203-212.*` -- Upgrade Gradle Wrapper to `7.2` -- Gradle – Changelog plugin configuration update -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.5.30` -- Dependencies - upgrade `org.jetbrains.changelog` to `1.3.0` -- Dependencies - upgrade `org.jetbrains.intellij` to `1.1.6` -- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v2.2.4` - -### Fixed - -- Use `DynamicBundle` instead of `AbstractBundle` in `MyBundle.kt` - -### Removed - -- Removed `detekt`/`ktlint` integration - -## [0.10.1] - 2021-05-31 - -### Added - -- Introduced `next` branch in the root repository to make `main` always a stable one - -### Changed - -- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.6` -- Trigger GitHub Actions `Build` workflows only on pushes to `main` branch or pull request to avoid duplicated checks - -## [0.10.0] - 2021-05-27 - -### Changed - -- Remove reference to the `jcenter()` from Gradle configuration file -- Update `pluginVerifierIdeVersions` to `2020.2.4, 2020.3.4, 2021.1.2` -- Update `pluginUntilBuild` to include `211.*` (2021.1.*) -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.5.10` -- Dependencies - upgrade `detekt-formatting from` to `1.17.1` -- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.17.1` -- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.5` -- Dependencies (GitHub Actions) - upgrade `actions/checkout` to `v2.3.4` -- Dependencies (GitHub Actions) - upgrade `actions/upload-release-asset` to `v1.0.2` -- Dependencies (GitHub Actions) - upgrade `actions/create-release` to `v1.1.4` -- Upgrade Gradle Wrapper to `7.0.2` - -## [0.9.0] - 2021-03-29 - -### Added - -- `properties` shorthand function for accessing `gradle.properties` in a cleaner way -- Dependabot check for GitHub Actions used in [workflow files](.github/workflows) - -### Changed - -- Dependencies - upgrade `detekt-formatting from` to `1.16.0` -- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.16.0` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.32` -- Dependencies (GitHub Actions) - upgrade `actions/upload-artifact` to `v2.2.2` -- Dependencies (GitHub Actions) - upgrade `actions/cache` to `v2.1.4` - -### Fixed - -- Fix `README.md` file resolution in the `build.gradle.kts` - -## [0.8.3] - 2021-02-23 - -### Changed - -- Dependencies - upgrade `org.jetbrains.intellij` to `0.7.2` -- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `10.0.0` -- Update `platformVersion` to `2020.2.4` for compatibility with macOS Big Sur -- Upgrade Gradle Wrapper to `6.8.3` - -## [0.8.2] - 2021-02-09 - -### Changed - -- Use `-bin` distribution of the Gradle Wrapper -- Upgrade Gradle Wrapper to `6.8.2` -- Update `pluginVerifierIdeVersions` in `gradle.properties` files -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.30` -- Dependencies - upgrade `org.jetbrains.changelog` to `1.1.1` -- Configure the `changelog` Gradle plugin - -## [0.8.1] - 2021-01-12 - -### Added - -- README: Dependencies management section - -### Changed - -- Upgrade Gradle Wrapper to `6.8` -- Dependencies - upgrade `org.jetbrains.changelog` to `1.0.0` - -### Fixed - -- Template Cleanup: Escape GitHub username to avoid incorrect characters in class package name -- Template Cleanup: Run `ktlintFormat` task to fix imports order -- GitHub Actions: Use the correct property in the "Upload artifact" step - -## [0.8.0] - 2020-12-21 - -### Added - -- Dependabot integration -- Show `idea.log` logs of the run IDE in the Run console -- README: FAQ section - -### Changed - -- `build.gradle.kts`: simpler syntax for configuring `KotlinCompile` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.21` -- Dependencies - upgrade `detekt-formatting` to `1.15.0` -- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.15.0` -- README: Clarifying the Java usage in the project -- `pluginVerifierIdeVersions` - upgrade to `2020.1.4, 2020.2.3, 2020.3.1` - -### Fixed - -- Return `Supplier<@Nls String>` instead of `String` in `MyBundle.messagePointer` - -## [0.7.1] - 2020-12-02 - -### Changed - -- Upgrade Gradle Wrapper to `6.7.1` -- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.5` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.20` -- Update the base platform version to 2020.1 -- Change since/until build to `201-203.*` - -## [0.7.0] - 2020-11-16 - -### Added - -- Predefined Run/Debug Configurations -- Project icon for development purposes - -### Changed - -- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.3` - -## [0.6.1] - 2020-11-05 - -### Added - -- GitHub Actions — use hash based on `pluginVerifierIdeVersions` in `Setup Plugin Verifier IDEs Cache` step - -### Changed - -- Use [Kotlin extension function](https://plugins.jetbrains.com/docs/intellij/plugin-services.html#retrieving-a-service) to retrieve the `MyProjectService` in the `MyProjectManagerListener` -- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.2` -- Update `pluginVerifierIdeVersions` in the `gradle.properties` files - -## [0.6.0] - 2020-10-29 - -### Added - -- 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 -- Cache downloaded IDEs used by Plugin Verifier for the verification - -### Changed - -- Switch Gradle Wrapper to `-all` to improve the IntelliSense -- Update detekt config to be in line with IJ settings -- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.14.2` -- Dependencies - upgrade `org.jetbrains.intellij` to `0.6.1` -- GitHub Actions — `gradleValidation` update to `gradle/wrapper-validation-action@v1.0.3` -- GitHub Actions — `releaseDraft` update to `actions/download-artifact@v2` - -### Removed - -- Remove Third-party IntelliJ Plugin Verifier GitHub Action - -## [0.5.1] - 2020-10-15 - -### Added - -- Missing properties in the `gradle.properties` template file - -### Changed - -- Upgrade Gradle Wrapper to `6.7` -- Dependencies - upgrade `org.jetbrains.changelog` to `0.6.2` - -## [0.5.0] - 2020-10-12 - -### Added - -- Introduced `platformPlugins` property in `gradle.properties` for configuring dependencies to bundled/external plugins - -### Changed - -- Disable "Release Draft" job for pull requests in the "Build" GitHub Actions Workflow -- Dependencies - upgrade `org.jetbrains.intellij` to `0.5.0` -- Dependencies - upgrade `org.jetbrains.changelog` to `0.6.1` -- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.14.1` -- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `9.4.1` -- Remove LICENSE file during the Template Cleanup workflow - -## [0.4.0] - 2020-10-02 - -### Added - -- Fix default to opt-out of bundling Kotlin standard library in plugin distribution - -### Changed - -- GitHub Actions: allow releasing plugin even for the base project -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.10` -- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.13.1` - -### Fixed - -- `pluginName` variable name collision with `intellij` closure getter in Gradle configuration #29 - -## [0.3.2] - 2020-08-09 - -### Changed - -- Simplify and optimize GitHub Actions -- Gradle Wrapper upgrade to `6.6.1` -- Dependencies - upgrade `org.jetbrains.kotlin.jvm` to `1.4.0` -- Dependencies - upgrade `org.jetbrains.intellij` to `0.4.22` -- Dependencies - upgrade `org.jetbrains.changelog` to `0.5.0` -- Dependencies - upgrade `io.gitlab.arturbosch.detekt` to `1.12.0` -- Dependencies - upgrade `org.jlleitschuh.gradle.ktlint` to `9.4.0` -- Rename `master` branch to `main` - -### Fixed - -- GitHub Actions — cache Gradle dependencies and wrapper separately - -## [0.3.1] - 2020-07-31 - -### Added - -- Better handling of the Gradle plugin description extraction from the README file -- GitHub Actions — cache Gradle Wrapper - -### Changed - -- Gradle - remove kotlin("stdlib-jdk8") dependency to decrease the plugin artifact size -- Dependencies - bump ktlint to `9.3.0` -- GitHub Actions — make *Update Changelog* job dependent on the *Publish Plugin* -- GitHub Actions — run plugin verifier against `2019.3` `2020.1` `2020.2` - -### Fixed - -- Resolve ktlint reports -- GitHub Actions — Plugin Verifier broken for artifacts with spaces in name - -## [0.3.0] - 2020-07-07 - -### Added - -- Set the publishing channel depending on the plugin version, i.e. `1.0.0-beta` -> `beta` channel - -### Changed - -- Update `org.jetbrains.changelog` dependency to `v0.3.3` -- Update Gradle Wrapper to `v6.5.1` -- Run GitHub Actions Release workflow on `prereleased` event -- GitHub Actions — Release, separate changelog-related job from the release - -### Fixed - -- Remove vendor website from `plugin.xml` -- Update Template Cleanup workflow test to avoid running it on forks - -## [0.2.0] - 2020-07-02 - -### Added - -- JetBrains Plugin badges and TODO list for the end users -- `ktlint` integration - -### Changed - -- `pluginUntilBuild` set to the correct format: `201.*` -- Bump detekt dependency to `1.10.0` - -### Fixed - -- GitHub Actions — Template Cleanup, fixed adding files to git -- Update Template plugin name on cleanup -- Set `buildUponDefaultConfig = true` in detekt configuration - -## [0.1.0] - 2020-06-26 - -### Added - -- `settings.gradle.kts` for the [performance purposes](https://docs.gradle.org/current/userguide/organizing_gradle_projects.html#always_define_a_settings_file) -- `#REMOVE-ON-CLEANUP#` token to mark content to be removed with **Template Cleanup** workflow - -### Changed - -- README proofreading -- GitHub Actions — Update IDE versions for the Plugin Verifier -- Update platformVersion to `2020.1.2` - -## [0.0.2] - 2020-06-22 - -### Added - -- [Gradle Changelog Plugin](https://github.com/JetBrains/gradle-changelog-plugin) integration - -### Changed - -- Bump Detekt version -- Change pluginSinceBuild to 193 - -## [0.0.1] - -### Added - -- Initial project scaffold -- GitHub Actions to automate testing and deployment -- Kotlin support - -[Unreleased]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.4.1...HEAD -[2.4.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.4.0...2.4.1 -[2.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.3.1...2.4.0 -[2.3.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.3.0...2.3.1 -[2.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.2.0...2.3.0 -[2.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.1.0...2.2.0 -[2.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.0.2...2.1.0 -[2.0.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.0.1...2.0.2 -[2.0.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/2.0.0...2.0.1 -[2.0.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.14.2...2.0.0 -[1.14.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.14.1...1.14.2 -[1.14.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.14.0...1.14.1 -[1.14.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.13.0...1.14.0 -[1.13.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.12.0...1.13.0 -[1.12.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.3...1.12.0 -[1.11.3]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.2...1.11.3 -[1.11.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.1...1.11.2 -[1.11.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.11.0...1.11.1 -[1.11.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.10.0...1.11.0 -[1.10.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.9.0...1.10.0 -[1.9.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.8.0...1.9.0 -[1.8.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.7.0...1.8.0 -[1.7.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.6.0...1.7.0 -[1.6.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.5.0...1.6.0 -[1.5.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.4.0...1.5.0 -[1.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.3.0...1.4.0 -[1.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.2.0...1.3.0 -[1.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.1.2...1.2.0 -[1.1.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.1.1...1.1.2 -[1.1.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.1.0...1.1.1 -[1.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/1.0.0...1.1.0 -[1.0.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.10.1...1.0.0 -[0.10.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.10.0...0.10.1 -[0.10.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.9.0...0.10.0 -[0.9.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.3...0.9.0 -[0.8.3]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.2...0.8.3 -[0.8.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.1...0.8.2 -[0.8.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.8.0...0.8.1 -[0.8.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.7.1...0.8.0 -[0.7.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.7.0...0.7.1 -[0.7.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.6.1...0.7.0 -[0.6.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.6.0...0.6.1 -[0.6.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.5.1...0.6.0 -[0.5.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.5.0...0.5.1 -[0.5.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.4.0...0.5.0 -[0.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.3.2...0.4.0 -[0.3.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.3.1...0.3.2 -[0.3.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.3.0...0.3.1 -[0.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.2.0...0.3.0 -[0.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.1.0...0.2.0 -[0.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.0.2...0.1.0 -[0.0.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/0.0.1...0.0.2 -[0.0.1]: https://github.com/JetBrains/intellij-platform-plugin-template/commits/0.0.1 +- Корректное удаление файлов и каталогов на удалённом сервере при локальном удалении diff --git a/README.md b/README.md index 50bfd1b..58a515b 100644 --- a/README.md +++ b/README.md @@ -1,538 +1,115 @@ -# IntelliJ Platform Plugin Template +# SSH Remote Sync -[![official JetBrains project](https://jb.gg/badges/official.svg)][jb:github] -[![Twitter Follow](https://img.shields.io/badge/follow-%40JBPlatform-1DA1F2?logo=twitter)](https://x.com/JBPlatform) -[![Build](https://github.com/JetBrains/intellij-platform-plugin-template/workflows/Build/badge.svg)][gh:build] +Плагин для IntelliJ IDEA, который позволяет работать с кодом на удалённых серверах так же удобно, как с локальным проектом. Файлы синхронизируются по SFTP, изменения отправляются на сервер при сохранении, а переключение между виртуальными машинами занимает несколько кликов. -![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-dark] -![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-light] +## Возможности -> [!NOTE] -> Click the Use this template button and clone it in IntelliJ IDEA. +- **Менеджер серверов** — добавление нескольких ВМ с хостом, портом, пользователем и путём к проекту. Пароли хранятся в системном хранилище IDE (`PasswordSafe`). +- **Открытие удалённого проекта** — при первом подключении плагин скачивает проект с сервера в локальную папку и открывает его в IDE. +- **Автосинхронизация** — при сохранении файла (`Ctrl+S`) изменения автоматически отправляются на сервер. Создание и удаление файлов тоже синхронизируется. +- **Обновление с сервера** — команда Refresh подтягивает изменения с удалённой машины, в том числе сделанные вне IDE. +- **Выполнение команд** — запуск произвольной команды на привязанном сервере через SSH `exec`. +- **Удалённый терминал** — встроенный терминал IDE, подключённый к серверу по SSH, с автоматическим переходом в папку проекта. +- **Переключение между серверами** — быстрое переключение между проектами разных ВМ без ручного поиска файлов. -**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). +## Требования -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. +- IntelliJ IDEA Community Edition **2024.1.7** или новее +- JDK **21** +- SSH-доступ к удалённому серверу (аутентификация по паролю) +- Bundled-плагин **Terminal** (включён в зависимости по умолчанию) -[gh:template]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template +## Быстрый старт -If you're still not quite sure what this is all about, read our introduction: [What is the IntelliJ Platform?][docs:intro] +### 1. Добавьте сервер -> [!NOTE] -> Click the Watch button on the top to be notified about releases containing new features and fixes. +Откройте **File → Settings → SSH Remote Project** и нажмите **+** (Add). -### Table of contents +Заполните поля: -In this README, we will highlight the following elements of template-project creation: +| Поле | Описание | +|------|----------| +| Name | Произвольное имя сервера | +| Host | IP-адрес или hostname | +| Port | SSH-порт (по умолчанию 22) | +| User | Имя пользователя | +| Password | Пароль (сохраняется в защищённом хранилище IDE) | +| Remote Path | Абсолютный путь к проекту на сервере, например `/home/user/myproject` | -- [Getting started](#getting-started) -- [Gradle configuration](#gradle-configuration) -- [Plugin template structure](#plugin-template-structure) -- [Plugin configuration file](#plugin-configuration-file) -- [Sample code](#sample-code): - - startup activity – project-open sample - - services – project-level service - - tool window – sample UI entry point -- [Testing](#testing) - - [Functional tests](#functional-tests) - - [UI tests](#ui-tests) -- [Predefined Run/Debug configurations](#predefined-rundebug-configurations) -- [Continuous integration](#continuous-integration) based on GitHub Actions - - [Dependencies management](#dependencies-management) with Dependabot - - [Changelog maintenance](#changelog-maintenance) with the Gradle Changelog Plugin - - [Release flow](#release-flow) using GitHub Releases - - [Plugin signing](#plugin-signing) with Marketplace signing - - [Publishing the plugin](#publishing-the-plugin) with the IntelliJ Platform Gradle Plugin -- [FAQ](#faq) -- [Useful links](#useful-links) +### 2. Откройте удалённый проект +Выберите **Tools → SSH Remote Manager → Switch Remote Server** и укажите нужный сервер. -## Getting started +Плагин скачает проект (если локальной копии ещё нет) и откроет его в IDE. -Before we dive into plugin development and everything related to it, it's worth mentioning the benefits of using GitHub Templates. -By creating a new project using the current template, you start with no history or reference to this repository. -This allows you to create a new repository easily without copying and pasting previous content, cloning repositories, or clearing the history manually. +### 3. Работайте как с локальным проектом -All you have to do is click the Use this template button (you must be logged in with your GitHub account). +- Редактируйте файлы — при сохранении они автоматически уйдут на сервер. +- Чтобы подтянуть изменения с сервера: **Tools → SSH Remote Manager → Refresh from Server**. +- Чтобы открыть SSH-терминал: **Tools → SSH Remote Manager → Open Remote Terminal**. -![Use this template][file:use-this-template.png] +## Локальное хранение проектов -After using the template to create your blank project, the [Template Cleanup][file:template_cleanup.yml] workflow will be triggered to override or remove any template-specific configurations, such as the plugin name, current changelog, etc. -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_. - -Now the project is ready to be cloned to your local environment and opened with [IntelliJ IDEA][jb:download-ij]. - -The most convenient way for getting your new project from GitHub is the Get from VCS action available on the Welcome Screen, where you can filter your GitHub repository by its name. - -![Get from Version Control][file:get-from-version-control] - -The next step, after opening your project in IntelliJ IDEA, is to set the proper SDK to Java in version `21` within the [Project Structure settings][docs:project-structure-settings]. - -![Project Structure — SDK][file:project-structure-sdk.png] - -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. -Then you can get to work implementing your ideas. - -> [!NOTE] -> To use Java in your plugin, create the `/src/main/java` directory. - - -## Gradle configuration - -The recommended method for plugin development involves using the [Gradle][gradle] setup with the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin] installed. -The IntelliJ Platform Gradle Plugin makes it possible to run the IDE with your plugin and publish your plugin to JetBrains Marketplace. - -> [!NOTE] -> Make sure to always upgrade to the latest version of IntelliJ Platform Gradle Plugin. - -A project built using the IntelliJ Platform Plugin Template includes a Gradle configuration already set up. -Feel free to read through the [Using Gradle][docs:using-gradle] articles to understand your build better and learn how to customize it. - -The most significant parts of the current configuration are: -- Integration with the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin] for smoother development. -- Repository configuration moved to [`settings.gradle.kts`][file:settings.gradle.kts] using the IntelliJ Platform repositories extension. -- Configuration written with [Gradle Kotlin DSL][gradle:kotlin-dsl]. -- Support for Kotlin and Java implementation. -- Plugin and dependency versions are declared directly in the Gradle build files. -- Integration with the [gradle-changelog-plugin][gh:gradle-changelog-plugin], which automatically patches the change notes based on the `CHANGELOG.md` file. -- [Plugin publishing][docs:publishing] through the `publishPlugin` task and GitHub Actions workflows. - -For more details regarding Kotlin integration, please see [Kotlin for Plugin Developers][docs:kotlin] in the IntelliJ Platform Plugin SDK documentation. - -### Gradle properties - -The project-specific configuration file [`gradle.properties`][file:gradle.properties] starts with values expected to vary between repositories created from this template: - -| Property name | Description | -|-----------------------|------------------------------------------------------------------------------------------------------| -| `group` | Project group and default base package for the sample sources. | -| `version` | Current plugin version in [SemVer][semver] format. | -| `pluginRepositoryUrl` | Repository URL used for generating URLs by the [Gradle Changelog Plugin][gh:gradle-changelog-plugin] | - -The remaining plugin metadata lives closer to where it is used: -- [`settings.gradle.kts`][file:settings.gradle.kts] declares Gradle plugin versions and repository management. -- [`build.gradle.kts`][file:build.gradle.kts] declares the target IntelliJ Platform version and project dependencies. -- [`plugin.xml`][file:plugin.xml] contains the plugin `id`, `name`, `vendor`, `description`, and extension registrations. - -It also configures Gradle build behavior flags, such as: - -| Property name | Value | Description | -|--------------------------------------------------|---------|------------------------------------------------------------------------------------------------| -| `kotlin.stdlib.default.dependency` | `false` | Opt-out flag for bundling [Kotlin standard library][docs:kotlin-stdlib] | -| `org.gradle.configuration-cache` | `true` | Enable [Gradle Configuration Cache][gradle:configuration-cache] | -| `org.gradle.caching` | `true` | Enable [Gradle Build Cache][gradle:build-cache] | - -### Environment variables - -Some values used during signing and publishing should not be stored in project files. - -Provide them through local *Run/Debug Configurations* or on CI, for example in GitHub under `Settings > Secrets and variables > Actions`. - -The current template uses the following variables for the [plugin signing](#plugin-signing) and [publishing](#publishing-the-plugin) flow: - -| Environment variable name | Description | -|---------------------------|--------------------------------------------------------------------------------------------------------------| -| `PRIVATE_KEY` | Certificate private key, should contain: `-----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY-----` | -| `PRIVATE_KEY_PASSWORD` | Password used for encrypting the certificate file. | -| `CERTIFICATE_CHAIN` | Certificate chain, should contain: `-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----` | -| `PUBLISH_TOKEN` | Publishing token generated in your JetBrains Marketplace profile dashboard. | - -For more details on how to generate proper values, check the relevant sections mentioned above. - -To configure GitHub secret environment variables, go to the `⚙️ Settings > Secrets and variables > Actions` section of your project repository: - -![Settings > Secrets][file:settings-secrets.png] - -## Plugin template structure - -A generated IntelliJ Platform Plugin Template repository contains the following content structure: +Каждый удалённый проект кэшируется локально по пути: ``` -. -├── .github/ GitHub Actions workflows and Dependabot configuration files -├── .run/ Predefined Run/Debug Configurations -├── gradle -│ └── wrapper/ Gradle Wrapper -├── src Plugin sources -│ ├── main -│ │ ├── kotlin/ Kotlin production sources -│ │ └── resources/ Resources - plugin.xml, icons, messages -│ └── test -│ ├── kotlin/ Kotlin test sources -│ └── testData/ Test data used by tests -├── .gitignore Git ignoring rules -├── build.gradle.kts Gradle configuration -├── CHANGELOG.md Full change history -├── gradle.properties Gradle configuration properties -├── gradlew *nix Gradle Wrapper script -├── gradlew.bat Windows Gradle Wrapper script -├── LICENSE License, MIT by default -├── README.md README -└── settings.gradle.kts Gradle project settings and repositories +~/ssh-remote-projects/// ``` -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]. +При повторном открытии того же сервера плагин использует уже скачанную копию и синхронизирует только изменённые файлы. -> [!NOTE] -> To use Java in your plugin, create the `/src/main/java` directory. +Служебные файлы IDE (`.idea/`, `remote.iml`) не синхронизируются с сервером. +## Меню плагина -## Plugin configuration file +Все действия доступны в **Tools → SSH Remote Manager**: -The plugin configuration file is a [plugin.xml][file:plugin.xml] file located in the `src/main/resources/META-INF` directory. -It provides general information about the plugin, its dependencies, and its extensions. -Maintain the plugin description directly in this file, using HTML wrapped in CDATA when needed. +| Действие | Описание | +|----------|----------| +| Configure SSH Servers | Открыть настройки серверов | +| Switch Remote Server | Переключиться на другой сервер / открыть его проект | +| Refresh from Server | Загрузить изменения с сервера | +| Run Remote Command | Выполнить команду на сервере | +| Open Remote Terminal | Открыть SSH-терминал в папке проекта | -> [!NOTE] -> When using this template for a real plugin, replace the placeholder description with content that describes the final plugin. +## Сборка и запуск из исходников -```xml - - org.jetbrains.plugins.template - IntelliJ Platform Plugin Template - JetBrains - Plugin description in HTML.

- ]]> - - com.intellij.modules.platform - - messages.MyBundle - - - - - - +```bash +./gradlew runIde ``` -You can read more about this file in the [Plugin Configuration File][docs:plugin.xml] section of our documentation. +Для сборки дистрибутива: - -## Sample code - -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). -Therefore, the template contains only the following files: - -``` -. -├── startup -│ └── MyProjectActivity.kt Project startup activity -├── services -│ └── MyProjectService.kt Project-level service -├── toolWindow -│ └── MyToolWindowFactory.kt Tool window factory — creates tool window content -└── MyBundle.kt Bundle class providing access to the resources messages +```bash +./gradlew buildPlugin ``` -These files are located in `src/main/kotlin`. -This location indicates the language being used. -So if you decide to use Java instead (or in addition to Kotlin), these sources should be located in the `src/main/java` directory. +Готовый архив появится в `build/distributions/`. -> [!TIP] -> It is possible to use the [IntelliJ Platform Icons](https://jb.gg/new-ui-icons) in your plugin. - -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. - -> [!WARNING] -> Remember to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`. - -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. - -## Testing - -[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. -The IntelliJ Platform Plugin Template project ships with functional test examples and leaves UI testing setup to the plugin author. - -### Functional tests - -Most of the IntelliJ Platform codebase tests are model-level, run in a headless environment using an actual IDE instance. -The tests usually test a feature as a whole rather than individual functions that comprise its implementation, like in unit tests. - -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. - -> [!NOTE] -> Run your tests using predefined *Run Tests* configuration or by invoking the `./gradlew check` Gradle task. - -### UI tests - -If your plugin provides complex user interfaces, you should consider covering them with tests and the functionality they use. - -The template does not wire UI testing into the Gradle build by default anymore. -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. - - -## Predefined Run/Debug configurations - -Within the default project structure, there is a `.run` directory provided containing predefined *Run/Debug configurations* that expose corresponding Gradle tasks: - -![Run/Debug configurations][file:run-debug-configurations.png] - -| Configuration name | Description | -|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Run Plugin | Runs [`:runIde`][gh:intellij-platform-gradle-plugin-runIde] IntelliJ Platform Gradle Plugin task. Use the *Debug* icon for plugin debugging. | -| Run Tests | Runs [`:check`][gradle:lifecycle-tasks] Gradle task. | -| 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. | - -> [!NOTE] -> You can find the logs from the running task in the `idea.log` tab. -> -> ![Run/Debug configuration logs][file:run-logs.png] - - -## Continuous integration - -Continuous integration depends on [GitHub Actions][gh:actions], a set of workflows that make it possible to automate your testing and release process. -Thanks to such automation, you can delegate the testing and verification phases to the Continuous Integration (CI) and instead focus on development (and writing more tests). - -> [!NOTE] -> 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`. - - -In the `.github/workflows` directory, you can find definitions for the following GitHub Actions workflows: - -- [Build](.github/workflows/build.yml) - - Triggered on `push` and `pull_request` events. - - Builds the plugin with the `buildPlugin` Gradle task and uploads the plugin ZIP as a workflow artifact. - - Runs the `check` Gradle task in a dedicated test job. - - Runs the `verifyPlugin` Gradle task in a dedicated verification job. - - Prepares a draft release of the GitHub Releases page for manual verification. -- [Release](.github/workflows/release.yml) - - Triggered on `prereleased` and `released` events. - - Updates `CHANGELOG.md` with the published release notes when a release body is provided. - - Signs the plugin with a provided certificate before publishing. - - Publishes the plugin to JetBrains Marketplace using the provided `PUBLISH_TOKEN`. - - Uploads the built plugin distribution as a GitHub release asset. - - Creates a pull request with the patched changelog when needed. -- [Template Cleanup](.github/workflows/template-cleanup.yml) - - Triggered once on the `push` event when a new template-based repository has been created. - - Overrides the scaffold with files from the `.github/template-cleanup` directory. - - Overrides JetBrains-specific sentences or package names with ones specific to the target repository. - - Removes redundant files. - -All the workflow files include inline documentation, so it's a good idea to take a look through their sources. - -### Dependencies management - -This template keeps dependency management explicit and local to the Gradle files that use it: -- [`settings.gradle.kts`][file:settings.gradle.kts] declares Gradle plugin versions and repositories. -- [`build.gradle.kts`][file:build.gradle.kts] declares the target IntelliJ Platform version and project dependencies. -- [`gradle.properties`][file:gradle.properties] stores repository-specific metadata shared by the build and CI workflows. - -> [!NOTE] -> To add a regular library dependency, declare it directly in the `dependencies { ... }` block: -> -> ```kotlin -> dependencies { -> implementation("group:artifact:version") -> } -> ``` -> -> 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]. - -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]. - -Dependabot is a bot provided by GitHub that checks build configuration files for outdated or insecure dependencies. -When an update is available, it creates a new pull request providing [the proper change][gh:dependabot-pr]. - -> [!NOTE] -> Dependabot supports [Gradle Wrapper updates][gh:dependabot-supported-ecosystems]. -> To update Gradle manually, check the [Gradle Releases][gradle:releases] page and run -> ```bash -> ./gradlew wrapper --gradle-version && ./gradlew wrapper -> ``` - -### Changelog maintenance - -When releasing an update, it is essential to let your users know what the new version offers. -The best way to do this is to provide release notes. - -The changelog is a curated list that contains information about any new features, fixes, and deprecations. -When they're provided, these lists are available in a few different places: -- the [CHANGELOG.md](./CHANGELOG.md) file, -- the [Releases page][gh:releases], -- the *What's new* section of the JetBrains Marketplace Plugin page, -- and inside the Plugin Manager's item details. - -There are many methods for handling the project's changelog. -The one used in the current template project is the [Keep a Changelog][keep-a-changelog] approach. - -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]. -You only have to take care of writing down the actual changes in proper sections of the `[Unreleased]` section. - -You start with an almost empty changelog: +## Структура проекта ``` -# YourPlugin Changelog - -## [Unreleased] -### Added -- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) +src/main/java/com/example/plugin/ +├── SshServer.java # Модель сервера +├── SshServerManager.java # Хранение серверов и паролей +├── ProjectServerMapping.java # Связь локального проекта с сервером +├── SftpSessionManager.java # SSH/SFTP-сессии +├── SshSyncStartupActivity.java # Автосинхронизация при старте и сохранении +├── ConnectToRemoteAction.java # Скачивание и открытие проекта +├── SwitchServerAction.java # Переключение серверов +├── RefreshFromServerAction.java +├── RemoteCommandAction.java +├── OpenRemoteTerminalAction.java +├── SshTtyConnector.java # Мост SSH → встроенный терминал +└── SshServerConfigurable.java # UI настроек ``` -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). +## Ограничения -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. -GitHub Actions will swap it and provide you with an empty section for the next release so that you can proceed with your development: +- Поддерживается только аутентификация по паролю (ключи SSH пока не поддерживаются). +- Проверка host key отключена (`StrictHostKeyChecking=no`) — удобно для dev-сред, но не рекомендуется для production без дополнительных мер. +- Синхронизация файловая, без разрешения конфликтов: при Refresh перезаписываются файлы, которые отличаются от серверных по размеру или времени модификации. -``` -# YourPlugin Changelog +## Лицензия -## [Unreleased] - -## [0.0.1] -### Added -- An awesome feature -- Initial scaffold created from [IntelliJ Platform Plugin Template](https://github.com/JetBrains/intellij-platform-plugin-template) - -### Fixed -- One annoying bug -``` - -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. - -### Release flow - -The release process depends on the workflows already described above. -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. - -![Release draft][file:draft-release.png] - -The draft release is a working copy of a release, which you can review before publishing. -It uses the current plugin version from [`gradle.properties`][file:gradle.properties] as both the title and git tag, for example, `0.0.1`. -The changelog is provided automatically using the [gradle-changelog-plugin][gh:gradle-changelog-plugin]. -The built plugin archive is uploaded as a workflow artifact during the Build run rather than attached to the draft release itself. -Every new Build overrides the previous draft to keep your *Releases* page clean. - -When you edit the draft and use the Publish release button, GitHub will tag your repository with the given version and add a new entry to the Releases tab. -Next, it will notify users who are *watching* the repository, triggering the final [Release](.github/workflows/release.yml) workflow. - -### Plugin signing - -Plugin Signing is a mechanism introduced in the 2021.2 release cycle to increase security in [JetBrains Marketplace](https://plugins.jetbrains.com) and all of our IntelliJ-based IDEs. - -JetBrains Marketplace signing is designed to ensure that plugins aren't modified over the course of the publishing and delivery pipeline. - -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. -That allows you to sign and publish your plugin from both the Continuous Integration (CI) and local environments without checking secrets into VCS. - -To find out how to generate signing certificates, check the [Plugin Signing][docs:plugin-signing] section in the IntelliJ Platform Plugin SDK documentation. - -### Publishing the plugin - -> [!TIP] -> Make sure to follow all guidelines listed in [Publishing a Plugin][docs:publishing] to follow all recommended and required steps. - -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]. -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. - -> [!NOTE] -> 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]. - -The authorization process relies on the `PUBLISH_TOKEN` secret environment variable, specified in the `⚙️ Settings > Secrets and variables > Actions` section of your project repository. - -You can get that token in your JetBrains Marketplace profile dashboard in the [My Tokens][jb:my-tokens] tab. - -> [!WARNING] -> 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. -> Please follow the [Publishing a Plugin][docs:publishing] instructions. - - -## FAQ - -### How to use Java in my project? - -Java language is supported by default along with Kotlin. -Initially, the `/src/main/kotlin` directory is available with minimal examples. -You can still replace it or add the `/src/main/java` directory to start working with Java language instead. - -### How to disable *tests* or *build* job using the `[skip ci]` commit message? - -Since February 2021, GitHub Actions [has supported the skip CI feature][github-actions-skip-ci]. -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. - -### Why does the draft release no longer contain a built plugin artifact? - -All binaries created by the workflows are still available as workflow artifacts together with failed test reports or Plugin Verifier results. -That approach gives more possibilities for testing and debugging pre-releases, for example, in your local environment. - -## Useful links - -- [IntelliJ Platform Plugin SDK][docs] -- [IntelliJ Platform Gradle Plugin Documentation][gh:intellij-platform-gradle-plugin-docs] -- [IntelliJ Platform Explorer][jb:ipe] -- [JetBrains Marketplace Quality Guidelines][jb:quality-guidelines] -- [IntelliJ Platform UI Guidelines][jb:ui-guidelines] -- [JetBrains Marketplace Paid Plugins][jb:paid-plugins] -- [Kotlin UI DSL][docs:kotlin-ui-dsl] -- [IntelliJ SDK Code Samples][gh:code-samples] -- [JetBrains Platform Slack][jb:slack] -- [JetBrains Platform Twitter][jb:twitter] -- [IntelliJ IDEA Open API and Plugin Development Forum][jb:forum] -- [Keep a Changelog][keep-a-changelog] -- [GitHub Actions][gh:actions] - -[docs]: https://plugins.jetbrains.com/docs/intellij?from=IJPluginTemplate -[docs:intro]: https://plugins.jetbrains.com/docs/intellij/intellij-platform.html?from=IJPluginTemplate -[docs:kotlin-ui-dsl]: https://plugins.jetbrains.com/docs/intellij/kotlin-ui-dsl-version-2.html?from=IJPluginTemplate -[docs:kotlin]: https://plugins.jetbrains.com/docs/intellij/using-kotlin.html?from=IJPluginTemplate -[docs:kotlin-stdlib]: https://plugins.jetbrains.com/docs/intellij/using-kotlin.html?from=IJPluginTemplate#kotlin-standard-library -[docs:plugin.xml]: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html?from=IJPluginTemplate -[docs:publishing]: https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate -[docs:using-gradle]: https://plugins.jetbrains.com/docs/intellij/developing-plugins.html?from=IJPluginTemplate -[docs:plugin-signing]: https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate -[docs:project-structure-settings]: https://www.jetbrains.com/help/idea/project-settings-and-structure.html -[docs:testing-plugins]: https://plugins.jetbrains.com/docs/intellij/testing-plugins.html?from=IJPluginTemplate -[docs:integration-tests]: https://plugins.jetbrains.com/docs/intellij/integration-tests.html?from=IJPluginTemplate -[docs:integration-tests-ui]: https://plugins.jetbrains.com/docs/intellij/integration-tests-ui.html?from=IJPluginTemplate - -[file:build.gradle.kts]: ./build.gradle.kts -[file:draft-release.png]: ./.github/readme/draft-release.png -[file:get-from-version-control]: ./.github/readme/get-from-version-control.png -[file:gradle.properties]: ./gradle.properties -[file:intellij-platform-plugin-template-dark]: ./.github/readme/intellij-platform-plugin-template-dark.svg#gh-dark-mode-only -[file:intellij-platform-plugin-template-light]: ./.github/readme/intellij-platform-plugin-template-light.svg#gh-light-mode-only -[file:project-structure-sdk.png]: ./.github/readme/project-structure-sdk.png -[file:plugin.xml]: ./src/main/resources/META-INF/plugin.xml -[file:run-debug-configurations.png]: ./.github/readme/run-debug-configurations.png -[file:run-logs.png]: ./.github/readme/run-logs.png -[file:settings-secrets.png]: ./.github/readme/settings-secrets.png -[file:settings.gradle.kts]: ./settings.gradle.kts -[file:template_cleanup.yml]: ./.github/workflows/template-cleanup.yml -[file:use-this-template.png]: ./.github/readme/use-this-template.png - -[gh:actions]: https://docs.github.com/actions -[gh:build]: https://github.com/JetBrains/intellij-platform-plugin-template/actions?query=workflow%3ABuild -[gh:code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples -[gh:dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates -[gh:dependabot-pr]: https://github.com/JetBrains/intellij-platform-plugin-template/pull/73 -[gh:dependabot-supported-ecosystems]: https://docs.github.com/en/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories#gradle -[gh:gradle-changelog-plugin]: https://github.com/JetBrains/gradle-changelog-plugin -[gh:intellij-platform-gradle-plugin]: https://github.com/JetBrains/intellij-platform-gradle-plugin -[gh:intellij-platform-gradle-plugin-docs]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin.html -[gh:intellij-platform-gradle-plugin-runIde]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-tasks.html#runIde -[gh:intellij-platform-gradle-plugin-verifyPlugin]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-tasks.html#verifyPlugin -[gh:releases]: https://github.com/JetBrains/intellij-platform-plugin-template/releases - -[gradle]: https://gradle.org -[gradle:build-cache]: https://docs.gradle.org/current/userguide/build_cache.html -[gradle:configuration-cache]: https://docs.gradle.org/current/userguide/configuration_cache.html -[gradle:kotlin-dsl]: https://docs.gradle.org/current/userguide/kotlin_dsl.html -[gradle:lifecycle-tasks]: https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks -[gradle:releases]: https://gradle.org/releases - -[jb:github]: https://github.com/JetBrains/.github/blob/main/profile/README.md -[jb:download-ij]: https://www.jetbrains.com/idea/download -[jb:forum]: https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development -[jb:ipe]: https://jb.gg/ipe -[jb:my-tokens]: https://plugins.jetbrains.com/author/me/tokens -[jb:paid-plugins]: https://plugins.jetbrains.com/docs/marketplace/paid-plugins-marketplace.html -[jb:quality-guidelines]: https://plugins.jetbrains.com/docs/marketplace/quality-guidelines.html -[jb:slack]: https://plugins.jetbrains.com/slack -[jb:twitter]: https://twitter.com/JBPlatform -[jb:ui-guidelines]: https://jetbrains.github.io/ui - -[github-actions-skip-ci]: https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/ -[keep-a-changelog]: https://keepachangelog.com -[keep-a-changelog-how]: https://keepachangelog.com/en/1.0.0/#how -[semver]: https://semver.org +См. файл [LICENSE](LICENSE). diff --git a/gradle.properties b/gradle.properties index af673b6..3cf238f 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ group = org.jetbrains.plugins.template -version = 2.6.0 +version = 1.0.0 pluginRepositoryUrl = https://github.com/JetBrains/intellij-platform-plugin-template