mirror of
https://github.com/JetBrains/intellij-platform-plugin-template.git
synced 2026-01-21 16:19:22 +00:00
Compare commits
No commits in common. "main" and "2.0.1" have entirely different histories.
BIN
.github/readme/draft-release.png
vendored
BIN
.github/readme/draft-release.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 92 KiB |
BIN
.github/readme/run-debug-configurations.png
vendored
BIN
.github/readme/run-debug-configurations.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 97 KiB |
BIN
.github/readme/run-logs.png
vendored
BIN
.github/readme/run-logs.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 195 KiB After Width: | Height: | Size: 123 KiB |
BIN
.github/readme/settings-secrets.png
vendored
BIN
.github/readme/settings-secrets.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 345 KiB After Width: | Height: | Size: 264 KiB |
BIN
.github/readme/use-this-template.png
vendored
BIN
.github/readme/use-this-template.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 234 KiB After Width: | Height: | Size: 175 KiB |
1
.github/template-cleanup/README.md
vendored
1
.github/template-cleanup/README.md
vendored
@ -15,7 +15,6 @@
|
||||
- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables).
|
||||
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate).
|
||||
- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.
|
||||
- [ ] Configure the [CODECOV_TOKEN](https://docs.codecov.com/docs/quick-start) secret for automated test coverage reports on PRs
|
||||
|
||||
<!-- Plugin description -->
|
||||
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
|
||||
|
||||
10
.github/template-cleanup/gradle.properties
vendored
10
.github/template-cleanup/gradle.properties
vendored
@ -7,21 +7,21 @@ pluginRepositoryUrl = https://github.com/%REPOSITORY%
|
||||
pluginVersion = 0.0.1
|
||||
|
||||
# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
|
||||
pluginSinceBuild = 252
|
||||
pluginSinceBuild = 233
|
||||
pluginUntilBuild = 242.*
|
||||
|
||||
# IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
|
||||
platformVersion = 2025.2.5
|
||||
platformType = IC
|
||||
platformVersion = 2023.3.7
|
||||
|
||||
# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
|
||||
# Example: platformPlugins = com.jetbrains.php:203.4449.22, org.intellij.scala:2023.3.27@EAP
|
||||
platformPlugins =
|
||||
# Example: platformBundledPlugins = com.intellij.java
|
||||
platformBundledPlugins =
|
||||
# Example: platformBundledModules = intellij.spellchecker
|
||||
platformBundledModules =
|
||||
|
||||
# Gradle Releases -> https://github.com/gradle/gradle/releases
|
||||
gradleVersion = 9.2.1
|
||||
gradleVersion = 8.9
|
||||
|
||||
# Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib
|
||||
kotlin.stdlib.default.dependency = false
|
||||
|
||||
2
.github/template-cleanup/settings.gradle.kts
vendored
2
.github/template-cleanup/settings.gradle.kts
vendored
@ -1,5 +1,5 @@
|
||||
plugins {
|
||||
id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
|
||||
id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
|
||||
}
|
||||
|
||||
rootProject.name = "%NAME%"
|
||||
|
||||
132
.github/workflows/build.yml
vendored
132
.github/workflows/build.yml
vendored
@ -26,33 +26,52 @@ concurrency:
|
||||
|
||||
jobs:
|
||||
|
||||
# Prepare the environment and build the plugin
|
||||
# Prepare environment and build the plugin
|
||||
build:
|
||||
name: Build
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
version: ${{ steps.properties.outputs.version }}
|
||||
changelog: ${{ steps.properties.outputs.changelog }}
|
||||
pluginVerifierHomeDir: ${{ steps.properties.outputs.pluginVerifierHomeDir }}
|
||||
steps:
|
||||
|
||||
# Free GitHub Actions Environment Disk Space
|
||||
- name: Maximize Build Space
|
||||
uses: jlumbroso/free-disk-space@v1.3.1
|
||||
with:
|
||||
tool-cache: false
|
||||
large-packages: false
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Set up the Java environment for the next steps
|
||||
# Validate wrapper
|
||||
- name: Gradle Wrapper Validation
|
||||
uses: gradle/actions/wrapper-validation@v3
|
||||
|
||||
# Set up Java environment for the next steps
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v5
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: zulu
|
||||
java-version: 21
|
||||
java-version: 17
|
||||
|
||||
# Setup Gradle
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v5
|
||||
uses: gradle/actions/setup-gradle@v3
|
||||
with:
|
||||
gradle-home-cache-cleanup: true
|
||||
|
||||
# Set environment variables
|
||||
- name: Export Properties
|
||||
id: properties
|
||||
shell: bash
|
||||
run: |
|
||||
PROPERTIES="$(./gradlew properties --console=plain -q)"
|
||||
VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')"
|
||||
CHANGELOG="$(./gradlew getChangelog --unreleased --no-header --console=plain -q)"
|
||||
|
||||
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
||||
echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT
|
||||
|
||||
echo "changelog<<EOF" >> $GITHUB_OUTPUT
|
||||
echo "$CHANGELOG" >> $GITHUB_OUTPUT
|
||||
echo "EOF" >> $GITHUB_OUTPUT
|
||||
|
||||
# Build plugin
|
||||
- name: Build plugin
|
||||
@ -69,9 +88,9 @@ jobs:
|
||||
|
||||
echo "filename=${FILENAME:0:-4}" >> $GITHUB_OUTPUT
|
||||
|
||||
# Store an already-built plugin as an artifact for downloading
|
||||
# Store already-built plugin as an artifact for downloading
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: ${{ steps.artifact.outputs.filename }}
|
||||
path: ./build/distributions/content/*/*
|
||||
@ -83,29 +102,22 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
|
||||
# Free GitHub Actions Environment Disk Space
|
||||
- name: Maximize Build Space
|
||||
uses: jlumbroso/free-disk-space@v1.3.1
|
||||
with:
|
||||
tool-cache: false
|
||||
large-packages: false
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Set up the Java environment for the next steps
|
||||
# Set up Java environment for the next steps
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v5
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: zulu
|
||||
java-version: 21
|
||||
java-version: 17
|
||||
|
||||
# Setup Gradle
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v5
|
||||
uses: gradle/actions/setup-gradle@v3
|
||||
with:
|
||||
cache-read-only: true
|
||||
gradle-home-cache-cleanup: true
|
||||
|
||||
# Run tests
|
||||
- name: Run Tests
|
||||
@ -114,19 +126,18 @@ jobs:
|
||||
# Collect Tests Result of failed tests
|
||||
- name: Collect Tests Result
|
||||
if: ${{ failure() }}
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: tests-result
|
||||
path: ${{ github.workspace }}/build/reports/tests
|
||||
|
||||
# Upload the Kover report to CodeCov
|
||||
- name: Upload Code Coverage Report
|
||||
uses: codecov/codecov-action@v5
|
||||
uses: codecov/codecov-action@v4
|
||||
with:
|
||||
files: ${{ github.workspace }}/build/reports/kover/report.xml
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
|
||||
# Run Qodana inspections and provide a report
|
||||
# Run Qodana inspections and provide report
|
||||
inspectCode:
|
||||
name: Inspect code
|
||||
needs: [ build ]
|
||||
@ -139,28 +150,25 @@ jobs:
|
||||
|
||||
# Free GitHub Actions Environment Disk Space
|
||||
- name: Maximize Build Space
|
||||
uses: jlumbroso/free-disk-space@v1.3.1
|
||||
uses: jlumbroso/free-disk-space@main
|
||||
with:
|
||||
tool-cache: false
|
||||
large-packages: false
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.sha }} # to check out the actual pull request commit, not the merge commit
|
||||
fetch-depth: 0 # a full history is required for pull request analysis
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Set up the Java environment for the next steps
|
||||
# Set up Java environment for the next steps
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v5
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: zulu
|
||||
java-version: 21
|
||||
java-version: 17
|
||||
|
||||
# Run Qodana inspections
|
||||
- name: Qodana - Code Inspection
|
||||
uses: JetBrains/qodana-action@v2025.1.1
|
||||
uses: JetBrains/qodana-action@v2024.1.5
|
||||
with:
|
||||
cache-default-branch-only: true
|
||||
|
||||
@ -173,42 +181,49 @@ jobs:
|
||||
|
||||
# Free GitHub Actions Environment Disk Space
|
||||
- name: Maximize Build Space
|
||||
uses: jlumbroso/free-disk-space@v1.3.1
|
||||
uses: jlumbroso/free-disk-space@main
|
||||
with:
|
||||
tool-cache: false
|
||||
large-packages: false
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Set up the Java environment for the next steps
|
||||
# Set up Java environment for the next steps
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v5
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: zulu
|
||||
java-version: 21
|
||||
java-version: 17
|
||||
|
||||
# Setup Gradle
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v5
|
||||
uses: gradle/actions/setup-gradle@v3
|
||||
with:
|
||||
cache-read-only: true
|
||||
gradle-home-cache-cleanup: true
|
||||
|
||||
# Cache Plugin Verifier IDEs
|
||||
- name: Setup Plugin Verifier IDEs Cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ${{ needs.build.outputs.pluginVerifierHomeDir }}/ides
|
||||
key: plugin-verifier-${{ hashFiles('build/listProductsReleases.txt') }}
|
||||
|
||||
# Run Verify Plugin task and IntelliJ Plugin Verifier tool
|
||||
- name: Run Plugin Verification tasks
|
||||
run: ./gradlew verifyPlugin
|
||||
run: ./gradlew verifyPlugin -Dplugin.verifier.home.dir=${{ needs.build.outputs.pluginVerifierHomeDir }}
|
||||
|
||||
# Collect Plugin Verifier Result
|
||||
- name: Collect Plugin Verifier Result
|
||||
if: ${{ always() }}
|
||||
uses: actions/upload-artifact@v5
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: pluginVerifier-result
|
||||
path: ${{ github.workspace }}/build/reports/pluginVerifier
|
||||
|
||||
# Prepare a draft release for GitHub Releases page for the manual verification
|
||||
# If accepted and published, the release workflow would be triggered
|
||||
# If accepted and published, release workflow would be triggered
|
||||
releaseDraft:
|
||||
name: Release draft
|
||||
if: github.event_name != 'pull_request'
|
||||
@ -220,7 +235,7 @@ jobs:
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Remove old release drafts by using the curl request for the available releases with a draft flag
|
||||
- name: Remove Old Release Drafts
|
||||
@ -236,11 +251,10 @@ jobs:
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
VERSION=$(./gradlew properties --property version --quiet --console=plain | tail -n 1 | cut -f2- -d ' ')
|
||||
RELEASE_NOTE="./build/tmp/release_note.txt"
|
||||
./gradlew getChangelog --unreleased --no-header --quiet --console=plain --output-file=$RELEASE_NOTE
|
||||
|
||||
gh release create $VERSION \
|
||||
gh release create "v${{ needs.build.outputs.version }}" \
|
||||
--draft \
|
||||
--title $VERSION \
|
||||
--notes-file $RELEASE_NOTE
|
||||
--title "v${{ needs.build.outputs.version }}" \
|
||||
--notes "$(cat << 'EOM'
|
||||
${{ needs.build.outputs.changelog }}
|
||||
EOM
|
||||
)"
|
||||
|
||||
49
.github/workflows/release.yml
vendored
49
.github/workflows/release.yml
vendored
@ -1,5 +1,5 @@
|
||||
# GitHub Actions Workflow created for handling the release process based on the draft release prepared with the Build workflow.
|
||||
# Running the publishPlugin task requires all the following secrets to be provided: PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN.
|
||||
# Running the publishPlugin task requires all following secrets to be provided: PUBLISH_TOKEN, PRIVATE_KEY, PRIVATE_KEY_PASSWORD, CERTIFICATE_CHAIN.
|
||||
# See https://plugins.jetbrains.com/docs/intellij/plugin-signing.html for more information.
|
||||
|
||||
name: Release
|
||||
@ -18,43 +18,46 @@ jobs:
|
||||
pull-requests: write
|
||||
steps:
|
||||
|
||||
# Free GitHub Actions Environment Disk Space
|
||||
- name: Maximize Build Space
|
||||
uses: jlumbroso/free-disk-space@v1.3.1
|
||||
with:
|
||||
tool-cache: false
|
||||
large-packages: false
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.release.tag_name }}
|
||||
|
||||
# Set up the Java environment for the next steps
|
||||
# Set up Java environment for the next steps
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v5
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: zulu
|
||||
java-version: 21
|
||||
java-version: 17
|
||||
|
||||
# Setup Gradle
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v5
|
||||
uses: gradle/actions/setup-gradle@v3
|
||||
with:
|
||||
cache-read-only: true
|
||||
gradle-home-cache-cleanup: true
|
||||
|
||||
# Set environment variables
|
||||
- name: Export Properties
|
||||
id: properties
|
||||
shell: bash
|
||||
run: |
|
||||
CHANGELOG="$(cat << 'EOM' | sed -e 's/^[[:space:]]*$//g' -e '/./,$!d'
|
||||
${{ github.event.release.body }}
|
||||
EOM
|
||||
)"
|
||||
|
||||
echo "changelog<<EOF" >> $GITHUB_OUTPUT
|
||||
echo "$CHANGELOG" >> $GITHUB_OUTPUT
|
||||
echo "EOF" >> $GITHUB_OUTPUT
|
||||
|
||||
# Update the Unreleased section with the current release note
|
||||
- name: Patch Changelog
|
||||
if: ${{ github.event.release.body != '' }}
|
||||
if: ${{ steps.properties.outputs.changelog != '' }}
|
||||
env:
|
||||
CHANGELOG: ${{ github.event.release.body }}
|
||||
CHANGELOG: ${{ steps.properties.outputs.changelog }}
|
||||
run: |
|
||||
RELEASE_NOTE="./build/tmp/release_note.txt"
|
||||
mkdir -p "$(dirname "$RELEASE_NOTE")"
|
||||
echo "$CHANGELOG" > $RELEASE_NOTE
|
||||
|
||||
./gradlew patchChangelog --release-note-file=$RELEASE_NOTE
|
||||
./gradlew patchChangelog --release-note="$CHANGELOG"
|
||||
|
||||
# Publish the plugin to JetBrains Marketplace
|
||||
- name: Publish Plugin
|
||||
@ -65,7 +68,7 @@ jobs:
|
||||
PRIVATE_KEY_PASSWORD: ${{ secrets.PRIVATE_KEY_PASSWORD }}
|
||||
run: ./gradlew publishPlugin
|
||||
|
||||
# Upload an artifact as a release asset
|
||||
# Upload artifact as a release asset
|
||||
- name: Upload Release Asset
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@ -73,7 +76,7 @@ jobs:
|
||||
|
||||
# Create a pull request
|
||||
- name: Create Pull Request
|
||||
if: ${{ github.event.release.body != '' }}
|
||||
if: ${{ steps.properties.outputs.changelog != '' }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
|
||||
12
.github/workflows/run-ui-tests.yml
vendored
12
.github/workflows/run-ui-tests.yml
vendored
@ -33,20 +33,20 @@ jobs:
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Set up the Java environment for the next steps
|
||||
# Set up Java environment for the next steps
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v5
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: zulu
|
||||
java-version: 21
|
||||
java-version: 17
|
||||
|
||||
# Setup Gradle
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v5
|
||||
uses: gradle/actions/setup-gradle@v3
|
||||
with:
|
||||
cache-read-only: true
|
||||
gradle-home-cache-cleanup: true
|
||||
|
||||
# Run IDEA prepared for UI testing
|
||||
- name: Run IDE
|
||||
|
||||
4
.github/workflows/template-cleanup.yml
vendored
4
.github/workflows/template-cleanup.yml
vendored
@ -19,7 +19,7 @@ jobs:
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Cleanup project
|
||||
- name: Cleanup
|
||||
@ -74,7 +74,7 @@ jobs:
|
||||
|
||||
# Push changes
|
||||
- name: Push changes
|
||||
uses: ad-m/github-push-action@v0.8.0
|
||||
uses: ad-m/github-push-action@master
|
||||
with:
|
||||
branch: main
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
2
.github/workflows/template-verify.yml
vendored
2
.github/workflows/template-verify.yml
vendored
@ -23,7 +23,7 @@ jobs:
|
||||
|
||||
# Check out the current repository
|
||||
- name: Fetch Sources
|
||||
uses: actions/checkout@v5
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Compare `gradle.properties` with `.github/template-cleanup/gradle.properties`
|
||||
- name: Verify gradle.properties
|
||||
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,7 +1,5 @@
|
||||
.DS_Store
|
||||
.gradle
|
||||
.idea
|
||||
.intellijPlatform
|
||||
.kotlin
|
||||
.qodana
|
||||
build
|
||||
|
||||
@ -5,7 +5,6 @@
|
||||
<option name="linkedExternalProjectsSettings">
|
||||
<GradleProjectSettings>
|
||||
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||
<option name="gradleJvm" value="21" />
|
||||
<option name="modules">
|
||||
<set>
|
||||
<option value="$PROJECT_DIR$" />
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<component name="ProjectRunConfigurationManager">
|
||||
<configuration default="false" name="Run Plugin" type="GradleRunConfiguration" factoryName="Gradle">
|
||||
<log_file alias="IDE logs" path="$PROJECT_DIR$/build/idea-sandbox/*/log/idea.log" show_all="true" />
|
||||
<log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log" />
|
||||
<ExternalSystemSettings>
|
||||
<option name="executionName" />
|
||||
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||
@ -16,10 +16,9 @@
|
||||
</option>
|
||||
<option name="vmOptions" value="" />
|
||||
</ExternalSystemSettings>
|
||||
<ExternalSystemDebugServerProcess>false</ExternalSystemDebugServerProcess>
|
||||
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||
<DebugAllEnabled>false</DebugAllEnabled>
|
||||
<RunAsTest>false</RunAsTest>
|
||||
<method v="2" />
|
||||
</configuration>
|
||||
</component>
|
||||
138
CHANGELOG.md
138
CHANGELOG.md
@ -4,133 +4,6 @@
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [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`
|
||||
@ -433,7 +306,7 @@
|
||||
### 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`
|
||||
- Enable [Gradle Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html) in `gradle.proeprties`
|
||||
- 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`
|
||||
@ -877,14 +750,7 @@
|
||||
- GitHub Actions to automate testing and deployment
|
||||
- Kotlin support
|
||||
|
||||
[Unreleased]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.4.0...HEAD
|
||||
[2.4.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.3.1...v2.4.0
|
||||
[2.3.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.3.0...v2.3.1
|
||||
[2.3.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.2.0...v2.3.0
|
||||
[2.2.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.1.0...v2.2.0
|
||||
[2.1.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.0.2...v2.1.0
|
||||
[2.0.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.0.1...v2.0.2
|
||||
[2.0.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.0.0...v2.0.1
|
||||
[Unreleased]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v2.0.0...HEAD
|
||||
[2.0.0]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.14.2...v2.0.0
|
||||
[1.14.2]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.14.1...v1.14.2
|
||||
[1.14.1]: https://github.com/JetBrains/intellij-platform-plugin-template/compare/v1.14.0...v1.14.1
|
||||
|
||||
137
README.md
137
README.md
@ -1,13 +1,15 @@
|
||||
# IntelliJ Platform Plugin Template
|
||||
|
||||
[][jb:github]
|
||||
[](https://x.com/JBPlatform)
|
||||
[](https://twitter.com/JBPlatform)
|
||||
[][gh:build]
|
||||
[](https://plugins.jetbrains.com/slack)
|
||||
|
||||
![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-dark]
|
||||
![IntelliJ Platform Plugin Template][file:intellij-platform-plugin-template-light]
|
||||
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> Click the <kbd>Use this template</kbd> button and clone it in IntelliJ IDEA.
|
||||
|
||||
<!-- Plugin description -->
|
||||
@ -20,7 +22,8 @@ The main goal of this template is to speed up the setup phase of plugin developm
|
||||
|
||||
If you're still not quite sure what this is all about, read our introduction: [What is the IntelliJ Platform?][docs:intro]
|
||||
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> Click the <kbd>Watch</kbd> button on the top to be notified about releases containing new features and fixes.
|
||||
|
||||
### Table of contents
|
||||
@ -45,7 +48,7 @@ In this README, we will highlight the following elements of template-project cre
|
||||
- [Changelog maintenance](#changelog-maintenance) with the Gradle Changelog Plugin
|
||||
- [Release flow](#release-flow) using GitHub Releases
|
||||
- [Plugin signing](#plugin-signing) with your private certificate
|
||||
- [Publishing the plugin](#publishing-the-plugin) with the IntelliJ Platform Gradle Plugin
|
||||
- [Publishing the plugin](#publishing-the-plugin) with the Gradle IntelliJ Plugin
|
||||
- [FAQ](#faq)
|
||||
- [Useful links](#useful-links)
|
||||
|
||||
@ -54,7 +57,7 @@ In this README, we will highlight the following elements of template-project cre
|
||||
|
||||
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.
|
||||
This allows you to create a new repository easily without copying and pasting previous content, clone repositories, or clearing the history manually.
|
||||
|
||||
All you have to do is click the <kbd>Use this template</kbd> button (you must be logged in with your GitHub account).
|
||||
|
||||
@ -73,26 +76,28 @@ The next step, after opening your project in IntelliJ IDEA, is to set the proper
|
||||
|
||||
![Project Structure — SDK][file:project-structure-sdk.png]
|
||||
|
||||
For the last step, you have to manually review the configuration variables described in the [`gradle.properties`][file:gradle.properties] file and *optionally* move sources from the `com.github.username.repository` package to the one that works best for you.
|
||||
For the last step, you have to manually review the configuration variables described in the [`gradle.properties`][file:gradle.properties] file and *optionally* move sources from the *com.github.username.repository* package to the one that works best for you.
|
||||
Then you can get to work implementing your ideas.
|
||||
|
||||
> [!NOTE]
|
||||
> **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.
|
||||
The recommended method for plugin development involves using the [Gradle][gradle] setup with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] installed.
|
||||
The `gradle-intellij-plugin` makes it possible to run the IDE with your plugin and publish your plugin to JetBrains Marketplace.
|
||||
|
||||
> [!NOTE]
|
||||
> Make sure to always upgrade to the latest version of IntelliJ Platform Gradle Plugin.
|
||||
> **Note**
|
||||
>
|
||||
> Make sure to always upgrade to the latest version of `gradle-intellij-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.
|
||||
- Integration with the [gradle-intellij-plugin][gh:gradle-intellij-plugin] for smoother development.
|
||||
- Configuration written with [Gradle Kotlin DSL][gradle:kotlin-dsl].
|
||||
- Support for Kotlin and Java implementation.
|
||||
- Integration with the [gradle-changelog-plugin][gh:gradle-changelog-plugin], which automatically patches the change notes based on the `CHANGELOG.md` file.
|
||||
@ -105,19 +110,19 @@ For more details regarding Kotlin integration, please see [Kotlin for Plugin Dev
|
||||
The project-specific configuration file [`gradle.properties`][file:gradle.properties] contains:
|
||||
|
||||
| Property name | Description |
|
||||
|--------------------------|------------------------------------------------------------------------------------------------------|
|
||||
|-----------------------|-----------------------------------------------------------------------------------------------------------|
|
||||
| `pluginGroup` | Package name - after *using* the template, this will be set to `com.github.username.repo`. |
|
||||
| `pluginName` | Plugin name displayed in JetBrains Marketplace. |
|
||||
| `pluginRepositoryUrl` | Repository URL used for generating URLs by the [Gradle Changelog Plugin][gh:gradle-changelog-plugin] |
|
||||
| `pluginVersion` | The current version of the plugin in [SemVer][semver] format. |
|
||||
| `pluginSinceBuild` | The `since-build` attribute of the `<idea-version>` tag. |
|
||||
| `pluginUntilBuild` | The `until-build` attribute of the `<idea-version>` tag. |
|
||||
| `platformType` | The type of IDE distribution. |
|
||||
| `platformVersion` | The version of the IntelliJ Platform IDE will be used to build the plugin. |
|
||||
| `platformPlugins` | Comma-separated list of dependencies to the plugins from the Plugin Repositories. |
|
||||
| `platformBundledPlugins` | Comma-separated list of dependencies to the bundled IDE plugins. |
|
||||
| `platformBundledModules` | Comma-separated list of dependencies to the bundled IDE modules. |
|
||||
| `platformPlugins` | Comma-separated list of dependencies to the bundled IDE plugins and plugins from the Plugin Repositories. |
|
||||
| `gradleVersion` | Version of Gradle used for plugin development. |
|
||||
|
||||
The properties listed define the plugin itself or configure the [intellij-platform-gradle-plugin][gh:intellij-platform-gradle-plugin] – check its documentation for more details.
|
||||
The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details.
|
||||
|
||||
In addition, extra behaviors are configured through the [`gradle.properties`][file:gradle.properties] file, such as:
|
||||
|
||||
@ -131,7 +136,7 @@ In addition, extra behaviors are configured through the [`gradle.properties`][fi
|
||||
|
||||
Some values used for the Gradle configuration shouldn't be stored in files to avoid publishing them to the Version Control System.
|
||||
|
||||
To avoid that, environment variables are introduced, which can be provided within the *Run/Debug Configuration* within the IDE, or on the CI – like for GitHub: `⚙️ Settings > Secrets and variables > Actions`.
|
||||
To avoid that, environment variables are introduced, which can be provided within the *Run/Debug Configuration* within the IDE, or on the CI – like for GitHub: `⚙️ Settings > Secrets`.
|
||||
|
||||
Environment variables used by the current project are related to the [plugin signing](#plugin-signing) and [publishing](#publishing-the-plugin).
|
||||
|
||||
@ -144,7 +149,7 @@ Environment variables used by the current project are related to the [plugin sig
|
||||
|
||||
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:
|
||||
To configure GitHub secret environment variables, go to the `⚙️ Settings > Secrets` section of your project repository:
|
||||
|
||||
![Settings > Secrets][file:settings-secrets.png]
|
||||
|
||||
@ -181,7 +186,8 @@ A generated IntelliJ Platform Plugin Template repository contains the following
|
||||
|
||||
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]
|
||||
> **Note**
|
||||
>
|
||||
> To use Java in your plugin, create the `/src/main/java` directory.
|
||||
|
||||
|
||||
@ -233,16 +239,15 @@ 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.
|
||||
|
||||
> [!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`.
|
||||
> **Warning**
|
||||
>
|
||||
> Don't forget 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.
|
||||
@ -253,9 +258,10 @@ The IntelliJ Platform Plugin Template project provides integration of two testin
|
||||
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.
|
||||
In `src/test/kotlin`, you'll 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]
|
||||
> **Note**
|
||||
>
|
||||
> Run your tests using predefined *Run Tests* configuration or by invoking the `./gradlew check` Gradle task.
|
||||
|
||||
### Code coverage
|
||||
@ -267,14 +273,15 @@ The final test report is sent to [CodeCov][codecov] for better results visualiza
|
||||
|
||||
### UI tests
|
||||
|
||||
If your plugin provides complex user interfaces, you should consider covering them with tests and the functionality they use.
|
||||
If your plugin provides complex user interfaces, you should consider covering them with tests and the functionality they utilize.
|
||||
|
||||
[IntelliJ UI Test Robot][gh:intellij-ui-test-robot] allows you to write and execute UI tests within the JetBrains IDE running instance.
|
||||
[IntelliJ UI Test Robot][gh:intellij-ui-test-robot] allows you to write and execute UI tests within the IntelliJ IDE running instance.
|
||||
You can use the [XPath query language][xpath] to find components in the currently available IDE view.
|
||||
Once IDE with `robot-server` has started, you can open the `http://localhost:8082` page that presents the currently available IDEA UI components hierarchy in HTML format and use a simple `XPath` generator, which can help test your plugin's interface.
|
||||
|
||||
> [!NOTE]
|
||||
> Run IDE for UI tests by invoking the `./gradlew runIdeForUiTests` and `./gradlew check` Gradle tasks.
|
||||
> **Note**
|
||||
>
|
||||
> Run IDE for UI tests using predefined *Run IDE for UI Tests* and then *Run Tests* configurations or by invoking the `./gradlew runIdeForUiTests` and `./gradlew check` Gradle tasks.
|
||||
|
||||
Check the UI Test Example project you can use as a reference for setting up UI testing in your plugin: [intellij-ui-test-robot/ui-test-example][gh:ui-test-example].
|
||||
|
||||
@ -308,7 +315,8 @@ Qodana inspections are accessible within the project on two levels:
|
||||
|
||||
Qodana inspection is configured with the `qodana { ... }` section in the Gradle build file and [`qodana.yml`][file:qodana.yml] YAML configuration file.
|
||||
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> Qodana requires Docker to be installed and available in your environment.
|
||||
|
||||
To run inspections, you can use a predefined *Run Qodana* configuration, which will provide a full report on `http://localhost:8080`, or invoke the Gradle task directly with the `./gradlew runInspections` command.
|
||||
@ -325,12 +333,15 @@ Within the default project structure, there is a `.run` directory provided conta
|
||||
![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 Plugin | Runs [`:runIde`][gh:gradle-intellij-plugin-runIde] Gradle IntelliJ Plugin task. Use the *Debug* icon for plugin debugging. |
|
||||
| Run Verifications | Runs [`:runPluginVerifier`][gh:gradle-intellij-plugin-runPluginVerifier] Gradle IntelliJ Plugin task to check the plugin compatibility against the specified IntelliJ IDEs. |
|
||||
| Run Tests | Runs [`:test`][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. |
|
||||
| Run IDE for UI Tests | Runs [`:runIdeForUiTests`][gh:intellij-ui-test-robot] Gradle IntelliJ Plugin task to allow for running UI tests within the IntelliJ IDE running instance. |
|
||||
| Run Qodana | Runs [`:runInspections`][gh:gradle-qodana-plugin] Gradle Qodana Plugin task. Starts Qodana inspections in a Docker container and serves generated report on `localhost:8080`. |
|
||||
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> You can find the logs from the running task in the `idea.log` tab.
|
||||
>
|
||||
> ![Run/Debug configuration logs][file:run-logs.png]
|
||||
@ -341,10 +352,6 @@ Within the default project structure, there is a `.run` directory provided conta
|
||||
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)
|
||||
@ -356,10 +363,10 @@ In the `.github/workflows` directory, you can find definitions for the following
|
||||
- Prepares a draft release of the GitHub Releases page for manual verification.
|
||||
- [Release](.github/workflows/release.yml)
|
||||
- Triggered on `released` event.
|
||||
- Updates `CHANGELOG.md` file with the content provided the release note.
|
||||
- Updates `CHANGELOG.md` file with the content provided with the release note.
|
||||
- Signs the plugin with a provided certificate before publishing.
|
||||
- Publishes the plugin to JetBrains Marketplace using the provided `PUBLISH_TOKEN`.
|
||||
- Sets a publication channel depending on the plugin version, i.e. `1.0.0-beta` -> `beta` channel.
|
||||
- Sets publish channel depending on the plugin version, i.e. `1.0.0-beta` -> `beta` channel.
|
||||
- Patches the Changelog and commits.
|
||||
- [Run UI Tests](.github/workflows/run-ui-tests.yml)
|
||||
- Triggered manually.
|
||||
@ -379,7 +386,8 @@ This Template project depends on Gradle plugins and external libraries – and d
|
||||
|
||||
All plugins and dependencies used by Gradle are managed with [Gradle version catalog][gradle:version-catalog], which defines versions and coordinates of your dependencies in the [`gradle/libs.versions.toml`][file:libs.versions.toml] file.
|
||||
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> To add a new dependency to the project, in the `dependencies { ... }` block, add:
|
||||
>
|
||||
> ```kotlin
|
||||
@ -397,11 +405,12 @@ All plugins and dependencies used by Gradle are managed with [Gradle version cat
|
||||
> annotations = { group = "org.jetbrains", name = "annotations", version.ref = "annotations" }
|
||||
> ```
|
||||
|
||||
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].
|
||||
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 to check the build configuration files and review any outdated or insecure dependencies of yours – in case if any update is available, it creates a new pull request providing [the proper change][gh:dependabot-pr].
|
||||
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> Dependabot doesn't yet support checking of the Gradle Wrapper.
|
||||
> Check the [Gradle Releases][gradle:releases] page and update your `gradle.properties` file with:
|
||||
> ```properties
|
||||
@ -421,13 +430,13 @@ The changelog is a curated list that contains information about any new features
|
||||
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,
|
||||
- the *What's new* section of 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].
|
||||
The [Gradle Changelog Plugin][gh:gradle-changelog-plugin] takes care of propagating information provided within the [CHANGELOG.md](./CHANGELOG.md) to the [Gradle IntelliJ Plugin][gh:gradle-intellij-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:
|
||||
@ -443,7 +452,7 @@ You start with an almost empty changelog:
|
||||
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:
|
||||
GitHub Actions will swap it and provide you an empty section for the next release so that you can proceed with your development:
|
||||
|
||||
```
|
||||
# YourPlugin Changelog
|
||||
@ -459,7 +468,7 @@ GitHub Actions will swap it and provide you with an empty section for the next r
|
||||
- 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.
|
||||
To configure how the Changelog plugin behaves, i.e., to create headers with the release date, see [Gradle Changelog Plugin][gh:gradle-changelog-plugin] README file.
|
||||
|
||||
### Release flow
|
||||
|
||||
@ -488,25 +497,29 @@ All the configuration related to the signing should be provided using [environme
|
||||
|
||||
To find out how to generate signing certificates, check the [Plugin Signing][docs:plugin-signing] section in the IntelliJ Platform Plugin SDK documentation.
|
||||
|
||||
> [!NOTE]
|
||||
> **Note**
|
||||
>
|
||||
> Remember to encode your secret environment variables using `base64` encoding to avoid issues with multi-line values.
|
||||
|
||||
### Publishing the plugin
|
||||
|
||||
> [!TIP]
|
||||
> **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].
|
||||
Releasing a plugin to [JetBrains Marketplace](https://plugins.jetbrains.com) is a straightforward operation that uses the `publishPlugin` Gradle task provided by the [gradle-intellij-plugin][gh:gradle-intellij-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]
|
||||
> **Note**
|
||||
>
|
||||
> Set a suffix to the plugin version to publish it in the custom repository channel, i.e. `v1.0.0-beta` will push your plugin to the `beta` [release channel][docs:release-channel].
|
||||
|
||||
The authorization process relies on the `PUBLISH_TOKEN` secret environment variable, specified in the `⚙️ Settings > Secrets and variables > Actions` section of your project repository.
|
||||
The authorization process relies on the `PUBLISH_TOKEN` secret environment variable, specified in the _Secrets_ section of the repository _Settings_.
|
||||
|
||||
You can get that token in your JetBrains Marketplace profile dashboard in the [My Tokens][jb:my-tokens] tab.
|
||||
|
||||
> [!WARNING]
|
||||
> **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.
|
||||
|
||||
@ -521,10 +534,10 @@ You can still replace it or add the `/src/main/java` directory to start working
|
||||
|
||||
### 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].
|
||||
Since February 2021, GitHub Actions [support 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?
|
||||
### Why draft release no longer contains built plugin artifact?
|
||||
|
||||
All the binaries created with each workflow are still available, but as an output artifact of each run together with tests and Qodana results.
|
||||
That approach gives more possibilities for testing and debugging pre-releases, for example, in your local environment.
|
||||
@ -532,7 +545,7 @@ That approach gives more possibilities for testing and debugging pre-releases, f
|
||||
## Useful links
|
||||
|
||||
- [IntelliJ Platform SDK Plugin SDK][docs]
|
||||
- [IntelliJ Platform Gradle Plugin Documentation][gh:intellij-platform-gradle-plugin-docs]
|
||||
- [Gradle IntelliJ Plugin Documentation][gh:gradle-intellij-plugin-docs]
|
||||
- [IntelliJ Platform Explorer][jb:ipe]
|
||||
- [JetBrains Marketplace Quality Guidelines][jb:quality-guidelines]
|
||||
- [IntelliJ Platform UI Guidelines][jb:ui-guidelines]
|
||||
@ -582,10 +595,10 @@ That approach gives more possibilities for testing and debugging pre-releases, f
|
||||
[gh:dependabot]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-dependencies-updated-automatically
|
||||
[gh:dependabot-pr]: https://github.com/JetBrains/intellij-platform-plugin-template/pull/73
|
||||
[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:gradle-intellij-plugin]: https://github.com/JetBrains/gradle-intellij-plugin
|
||||
[gh:gradle-intellij-plugin-docs]: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html
|
||||
[gh:gradle-intellij-plugin-runIde]: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-runide
|
||||
[gh:gradle-intellij-plugin-runPluginVerifier]: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#tasks-runpluginverifier
|
||||
[gh:gradle-qodana-plugin]: https://github.com/JetBrains/gradle-qodana-plugin
|
||||
[gh:intellij-ui-test-robot]: https://github.com/JetBrains/intellij-ui-test-robot
|
||||
[gh:kover]: https://github.com/Kotlin/kotlinx-kover
|
||||
|
||||
@ -16,7 +16,7 @@ version = providers.gradleProperty("pluginVersion").get()
|
||||
|
||||
// Set the JVM language level used to build the project.
|
||||
kotlin {
|
||||
jvmToolchain(21)
|
||||
jvmToolchain(17)
|
||||
}
|
||||
|
||||
// Configure project's dependencies
|
||||
@ -29,14 +29,13 @@ repositories {
|
||||
}
|
||||
}
|
||||
|
||||
// Dependencies are managed with Gradle version catalog - read more: https://docs.gradle.org/current/userguide/version_catalogs.html
|
||||
// Dependencies are managed with Gradle version catalog - read more: https://docs.gradle.org/current/userguide/platforms.html#sub:version-catalog
|
||||
dependencies {
|
||||
testImplementation(libs.junit)
|
||||
testImplementation(libs.opentest4j)
|
||||
|
||||
// IntelliJ Platform Gradle Plugin Dependencies Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html
|
||||
intellijPlatform {
|
||||
intellijIdea(providers.gradleProperty("platformVersion"))
|
||||
create(providers.gradleProperty("platformType"), providers.gradleProperty("platformVersion"))
|
||||
|
||||
// Plugin Dependencies. Uses `platformBundledPlugins` property from the gradle.properties file for bundled IntelliJ Platform plugins.
|
||||
bundledPlugins(providers.gradleProperty("platformBundledPlugins").map { it.split(',') })
|
||||
@ -44,9 +43,9 @@ dependencies {
|
||||
// Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file for plugin from JetBrains Marketplace.
|
||||
plugins(providers.gradleProperty("platformPlugins").map { it.split(',') })
|
||||
|
||||
// Module Dependencies. Uses `platformBundledModules` property from the gradle.properties file for bundled IntelliJ Platform modules.
|
||||
bundledModules(providers.gradleProperty("platformBundledModules").map { it.split(',') })
|
||||
|
||||
instrumentationTools()
|
||||
pluginVerifier()
|
||||
zipSigner()
|
||||
testFramework(TestFrameworkType.Platform)
|
||||
}
|
||||
}
|
||||
@ -54,7 +53,6 @@ dependencies {
|
||||
// Configure IntelliJ Platform Gradle Plugin - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-extension.html
|
||||
intellijPlatform {
|
||||
pluginConfiguration {
|
||||
name = providers.gradleProperty("pluginName")
|
||||
version = providers.gradleProperty("pluginVersion")
|
||||
|
||||
// Extract the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
|
||||
@ -85,6 +83,7 @@ intellijPlatform {
|
||||
|
||||
ideaVersion {
|
||||
sinceBuild = providers.gradleProperty("pluginSinceBuild")
|
||||
untilBuild = providers.gradleProperty("pluginUntilBuild")
|
||||
}
|
||||
}
|
||||
|
||||
@ -98,7 +97,7 @@ intellijPlatform {
|
||||
token = providers.environmentVariable("PUBLISH_TOKEN")
|
||||
// The pluginVersion is based on the SemVer (https://semver.org) and supports pre-release labels, like 2.1.7-alpha.3
|
||||
// Specify pre-release label to publish the plugin in a custom Release Channel automatically. Read more:
|
||||
// https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html#specifying-a-release-channel
|
||||
// https://plugins.jetbrains.com/docs/intellij/deployment.html#specifying-a-release-channel
|
||||
channels = providers.gradleProperty("pluginVersion").map { listOf(it.substringAfter('-', "").substringBefore('.').ifEmpty { "default" }) }
|
||||
}
|
||||
|
||||
@ -115,7 +114,7 @@ changelog {
|
||||
repositoryUrl = providers.gradleProperty("pluginRepositoryUrl")
|
||||
}
|
||||
|
||||
// Configure Gradle Kover Plugin - read more: https://kotlin.github.io/kotlinx-kover/gradle-plugin/#configuration-details
|
||||
// Configure Gradle Kover Plugin - read more: https://github.com/Kotlin/kotlinx-kover#configuration
|
||||
kover {
|
||||
reports {
|
||||
total {
|
||||
|
||||
10
codecov.yml
10
codecov.yml
@ -1,10 +0,0 @@
|
||||
coverage:
|
||||
status:
|
||||
project:
|
||||
default:
|
||||
informational: true
|
||||
threshold: 0%
|
||||
base: auto
|
||||
patch:
|
||||
default:
|
||||
informational: true
|
||||
@ -4,24 +4,24 @@ pluginGroup = org.jetbrains.plugins.template
|
||||
pluginName = IntelliJ Platform Plugin Template
|
||||
pluginRepositoryUrl = https://github.com/JetBrains/intellij-platform-plugin-template
|
||||
# SemVer format -> https://semver.org
|
||||
pluginVersion = 2.4.0
|
||||
pluginVersion = 2.0.1
|
||||
|
||||
# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
|
||||
pluginSinceBuild = 252
|
||||
pluginSinceBuild = 233
|
||||
pluginUntilBuild = 242.*
|
||||
|
||||
# IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
|
||||
platformVersion = 2025.2.5
|
||||
platformType = IC
|
||||
platformVersion = 2023.3.7
|
||||
|
||||
# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
|
||||
# Example: platformPlugins = com.jetbrains.php:203.4449.22, org.intellij.scala:2023.3.27@EAP
|
||||
platformPlugins =
|
||||
# Example: platformBundledPlugins = com.intellij.java
|
||||
platformBundledPlugins =
|
||||
# Example: platformBundledModules = intellij.spellchecker
|
||||
platformBundledModules =
|
||||
|
||||
# Gradle Releases -> https://github.com/gradle/gradle/releases
|
||||
gradleVersion = 9.2.1
|
||||
gradleVersion = 8.9
|
||||
|
||||
# Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib
|
||||
kotlin.stdlib.default.dependency = false
|
||||
|
||||
@ -1,18 +1,16 @@
|
||||
[versions]
|
||||
# libraries
|
||||
junit = "4.13.2"
|
||||
opentest4j = "1.3.0"
|
||||
|
||||
# plugins
|
||||
changelog = "2.5.0"
|
||||
intelliJPlatform = "2.10.5"
|
||||
kotlin = "2.2.21"
|
||||
kover = "0.9.3"
|
||||
qodana = "2025.2.2"
|
||||
changelog = "2.2.1"
|
||||
intelliJPlatform = "2.0.1"
|
||||
kotlin = "1.9.25"
|
||||
kover = "0.8.3"
|
||||
qodana = "2024.1.9"
|
||||
|
||||
[libraries]
|
||||
junit = { group = "junit", name = "junit", version.ref = "junit" }
|
||||
opentest4j = { group = "org.opentest4j", name = "opentest4j", version.ref = "opentest4j" }
|
||||
|
||||
[plugins]
|
||||
changelog = { id = "org.jetbrains.changelog", version.ref = "changelog" }
|
||||
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Binary file not shown.
2
gradle/wrapper/gradle-wrapper.properties
vendored
2
gradle/wrapper/gradle-wrapper.properties
vendored
@ -1,6 +1,6 @@
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
|
||||
networkTimeout=10000
|
||||
validateDistributionUrl=true
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
|
||||
12
gradlew
vendored
12
gradlew
vendored
@ -1,7 +1,7 @@
|
||||
#!/bin/sh
|
||||
|
||||
#
|
||||
# Copyright © 2015 the original authors.
|
||||
# Copyright © 2015-2021 the original authors.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
@ -86,7 +86,8 @@ done
|
||||
# shellcheck disable=SC2034
|
||||
APP_BASE_NAME=${0##*/}
|
||||
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
|
||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
|
||||
' "$PWD" ) || exit
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD=maximum
|
||||
@ -114,6 +115,7 @@ case "$( uname )" in #(
|
||||
NONSTOP* ) nonstop=true ;;
|
||||
esac
|
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
@ -171,6 +173,7 @@ fi
|
||||
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||
if "$cygwin" || "$msys" ; then
|
||||
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||
|
||||
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||
|
||||
@ -203,14 +206,15 @@ fi
|
||||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
# Collect all arguments for the java command:
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||
# and any embedded shellness will be escaped.
|
||||
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||
# treated as '${Hostname}' itself on the command line.
|
||||
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
|
||||
-classpath "$CLASSPATH" \
|
||||
org.gradle.wrapper.GradleWrapperMain \
|
||||
"$@"
|
||||
|
||||
# Stop when "xargs" is not available.
|
||||
|
||||
3
gradlew.bat
vendored
3
gradlew.bat
vendored
@ -70,10 +70,11 @@ goto fail
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
# Qodana configuration:
|
||||
# https://www.jetbrains.com/help/qodana/qodana-yaml.html
|
||||
|
||||
version: "1.0"
|
||||
linter: jetbrains/qodana-jvm-community:2024.3
|
||||
projectJDK: "21"
|
||||
version: 1.0
|
||||
linter: jetbrains/qodana-jvm-community:latest
|
||||
projectJDK: "17"
|
||||
profile:
|
||||
name: qodana.recommended
|
||||
exclude:
|
||||
|
||||
@ -1,5 +1 @@
|
||||
rootProject.name = "IntelliJ Platform Plugin Template"
|
||||
|
||||
plugins {
|
||||
id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
|
||||
}
|
||||
|
||||
@ -0,0 +1,12 @@
|
||||
package org.jetbrains.plugins.template.listeners
|
||||
|
||||
import com.intellij.openapi.application.ApplicationActivationListener
|
||||
import com.intellij.openapi.diagnostic.thisLogger
|
||||
import com.intellij.openapi.wm.IdeFrame
|
||||
|
||||
internal class MyApplicationActivationListener : ApplicationActivationListener {
|
||||
|
||||
override fun applicationActivated(ideFrame: IdeFrame) {
|
||||
thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.")
|
||||
}
|
||||
}
|
||||
@ -1,12 +0,0 @@
|
||||
package org.jetbrains.plugins.template.startup
|
||||
|
||||
import com.intellij.openapi.diagnostic.thisLogger
|
||||
import com.intellij.openapi.project.Project
|
||||
import com.intellij.openapi.startup.ProjectActivity
|
||||
|
||||
class MyProjectActivity : ProjectActivity {
|
||||
|
||||
override suspend fun execute(project: Project) {
|
||||
thisLogger().warn("Don't forget to remove all non-needed sample code files with their corresponding registration entries in `plugin.xml`.")
|
||||
}
|
||||
}
|
||||
@ -10,6 +10,9 @@
|
||||
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<toolWindow factoryClass="org.jetbrains.plugins.template.toolWindow.MyToolWindowFactory" id="MyToolWindow"/>
|
||||
<postStartupActivity implementation="org.jetbrains.plugins.template.startup.MyProjectActivity" />
|
||||
</extensions>
|
||||
|
||||
<applicationListeners>
|
||||
<listener class="org.jetbrains.plugins.template.listeners.MyApplicationActivationListener" topic="com.intellij.openapi.application.ApplicationActivationListener"/>
|
||||
</applicationListeners>
|
||||
</idea-plugin>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user