Skip to content

Commit 6356333

Browse files
committed
Update documentation, workflows, and build scripts for JDK 21 and modern Gradle setup.
1 parent 8ee9034 commit 6356333

File tree

7 files changed

+37
-47
lines changed

7 files changed

+37
-47
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Setting up development environment
22

3-
1. Check out this repository
4-
1. Open a folder with the project in the IntelliJ Ultimate using the `open` action button.
5-
1. Make sure that you on the latest develop branch (e.g 1.0.0-develop)
6-
1. Right-click on the `build.gradle` file, choose "Import Gradle project"
7-
1. When the Gradle sections appeared in the right bar, navigate there and right-click `magento-2-php-storm-plguin > Tasks -> Intellij -> runIde`
8-
1. Click on "Run "magento-2-php-storm-plugin" to run the plugin. You should see a new instance of IntelliJ launched with the plugin installed. Make sure that the plugin is enabled in IntelliJ settings and indexing is finished. Plugin features should be accessible at this point.
3+
1. Check out this repository.
4+
1. Open the project in IntelliJ IDEA.
5+
1. Make sure that you are on the latest develop branch (for example `5.4.0-develop`).
6+
1. Import the Gradle project from `build.gradle.kts`.
7+
1. Use **JDK 21** for both the project SDK and the Gradle JVM.
8+
1. In the Gradle tool window, run `Tasks > Intellij platform > runIde`.
9+
1. The task launches a PhpStorm sandbox with the plugin installed. Make sure that the plugin is enabled and indexing is finished before testing features.
910

1011
# Plugin publication
1112

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ If applicable, add screenshots to help explain your problem.
4040
**Please complete the following information:** (*)
4141

4242
- OS: [e.g. MacOS or Ubuntu Linux 20.04]
43-
- PhpStorm/Intellij version: [e.g. 2019.3.3]
43+
- PhpStorm/Intellij version: [e.g. 2026.1]
4444
- Plugin Version: [e.g. 1.0.0]
4545

4646
**Additional context**

.github/workflows/asset.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,17 @@ jobs:
1111

1212
steps:
1313
- uses: actions/checkout@v3
14-
- name: Set up JDK 17
14+
- name: Set up JDK 21
1515
uses: actions/setup-java@v3
1616
with:
17-
java-version: 17
17+
java-version: 21
1818
distribution: 'temurin'
1919
cache: gradle
20-
- name: Gradle wrapper
21-
run: gradle wrapper
2220
- name: Grant execute permission for gradlew
2321
run: chmod +x gradlew
2422

2523
- name: Build Plugin
26-
run: ./gradlew buildPlugin
24+
run: ./gradlew buildPlugin --no-daemon
2725

2826
- name: Upload Plugin to Release Assets
2927
uses: actions/upload-release-asset@v1

.github/workflows/gradle.yml

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ jobs:
1313

1414
steps:
1515
- uses: actions/checkout@v3
16-
- name: Set up JDK 17
16+
- name: Set up JDK 21
1717
uses: actions/setup-java@v3
1818
with:
19-
java-version: 17
19+
java-version: 21
2020
distribution: 'temurin'
2121
cache: gradle
2222
- uses: actions/cache@v3
@@ -27,22 +27,20 @@ jobs:
2727
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
2828
restore-keys: |
2929
${{ runner.os }}-gradle-
30-
- name: Gradle wrapper
31-
run: gradle wrapper
3230
- name: Grant execute permission for gradlew
3331
run: chmod +x gradlew
3432
- name: Run automated tests
35-
run: ./gradlew test -PexcludeTests="**/userInterface/**" --no-daemon
33+
run: ./gradlew test --no-daemon
3634

3735
build-windows:
3836
runs-on: windows-latest
3937

4038
steps:
4139
- uses: actions/checkout@v3
42-
- name: Set up JDK 17
40+
- name: Set up JDK 21
4341
uses: actions/setup-java@v3
4442
with:
45-
java-version: 17
43+
java-version: 21
4644
distribution: 'temurin'
4745
cache: gradle
4846
- uses: actions/cache@v3
@@ -53,22 +51,20 @@ jobs:
5351
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
5452
restore-keys: |
5553
${{ runner.os }}-gradle-
56-
- name: Gradle wrapper
57-
run: gradle wrapper
5854
- name: Grant execute permission for gradlew
5955
run: chmod +x gradlew
6056
- name: Run automated tests
61-
run: ./gradlew test -PexcludeTests="**/userInterface/**" --no-daemon
57+
run: ./gradlew test --no-daemon
6258

6359
build-macos:
6460
runs-on: macos-latest
6561

6662
steps:
6763
- uses: actions/checkout@v3
68-
- name: Set up JDK 17
64+
- name: Set up JDK 21
6965
uses: actions/setup-java@v3
7066
with:
71-
java-version: 17
67+
java-version: 21
7268
distribution: 'temurin'
7369
cache: gradle
7470
- uses: actions/cache@v3
@@ -79,12 +75,10 @@ jobs:
7975
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
8076
restore-keys: |
8177
${{ runner.os }}-gradle-
82-
- name: Gradle wrapper
83-
run: gradle wrapper
8478
- name: Grant execute permission for gradlew
8579
run: chmod +x gradlew
8680
- name: Run automated tests
87-
run: ./gradlew test -PexcludeTests="**/userInterface/**" --no-daemon
81+
run: ./gradlew test --no-daemon
8882

8983
static-tests:
9084
runs-on: ubuntu-latest
@@ -93,10 +87,10 @@ jobs:
9387
- uses: actions/checkout@v4
9488
with:
9589
fetch-depth: 0
96-
- name: Set up JDK 17
90+
- name: Set up JDK 21
9791
uses: actions/setup-java@v4
9892
with:
99-
java-version: 17
93+
java-version: 21
10094
distribution: 'temurin'
10195
cache: gradle
10296
- name: Qodana - Code Quality

.github/workflows/gradlepublish.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,16 @@ jobs:
1313

1414
steps:
1515
- uses: actions/checkout@v3
16-
- name: Set up JDK 17
16+
- name: Set up JDK 21
1717
uses: actions/setup-java@v3
1818
with:
19-
java-version: 17
19+
java-version: 21
2020
distribution: 'temurin'
2121
cache: gradle
22-
- name: Gradle wrapper
23-
run: gradle wrapper
2422
- name: Grant execute permission for gradlew
2523
run: chmod +x gradlew
2624
- name: Run publish plugin
27-
run: ./gradlew publishPlugin -i
25+
run: ./gradlew publishPlugin -i --no-daemon
2826
env:
2927
MAGENTO_PHPSTORM_intellijPublishToken: ${{ secrets.JET_BRAINS_TOKEN }}
3028
MAGENTO_PHPSTORM_isAlpha: false

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,19 @@
6363

6464
## Works with
6565

66-
* PhpStorm >= 2023.1
67-
* JRE >= 17
66+
* PhpStorm 2026+
6867

6968
## Setting up development environment
7069

71-
1. Check out this repository
72-
1. Open a folder with the project in the IntelliJ CE using the `open` action button.
73-
1. Make sure that you on the latest develop branch (e.g `5.4.0-develop`)
74-
1. Right-click on the `build.gradle` file, choose "Import Gradle project" (if this is not exist look for "Build module '<root folder name>'") (you need to have Gradle plugin installed)
75-
1. Check if the right SDK version is used for the project.
76-
- Current Java version for the project is **java 11**, so you should additionally download **SDK 11** and choose it in the module settings: `Right click by the project root > Open Module Settings > Project Settings > Project > Project SDK`
77-
- Check if right SDK version is used for the Gradle plugin: `Intellij IDEA > Preferences... > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVM` and choose your JDK.
78-
1. When the Gradle sections appeared in the right bar, navigate there and right-click `magento-2-php-storm-plugin > Tasks -> Intellij -> runIde`
79-
1. Click `Run "magento-2-php-storm-plugin"` to run the plugin. You should see a new instance of IntelliJ launched with the plugin installed. Make sure the plugin is enabled in IntelliJ settings and indexing is finished. Plugin features should be accessible at this point.
70+
1. Check out this repository.
71+
1. Open the project in IntelliJ IDEA.
72+
1. Make sure that you are on the latest develop branch (for example `5.4.0-develop`).
73+
1. Import the Gradle project from `build.gradle.kts`.
74+
1. Use **JDK 21** for both the project SDK and the Gradle JVM:
75+
- `Right click on the project root > Open Module Settings > Project > Project SDK`
76+
- `IntelliJ IDEA > Preferences > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVM`
77+
1. In the Gradle tool window, run `Tasks > Intellij platform > runIde`.
78+
1. The task launches a PhpStorm sandbox with the plugin installed. Make sure the plugin is enabled and indexing is finished before testing features.
8079

8180
## How to contribute
8281
1) Start with looking into [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22). Any ticket in `Ready for Development` and `Good First Issue` columns are a good candidates to start.
@@ -124,4 +123,4 @@ declare(strict_types=1);
124123

125124
Each Magento source file included in this distribution is licensed under OSL-3.0 license.
126125

127-
Please read the [LICENSE.txt](https://github.com/magento/magento2-phpstorm-plugin/blob/master/LICENSE.txt) for the full text of the [Open Software License v. 3.0 (OSL-3.0)](http://opensource.org/licenses/osl-3.0.php).
126+
Please read the [LICENSE.txt](https://github.com/magento/magento2-phpstorm-plugin/blob/5.4.0-develop/LICENSE.txt) for the full text of the [Open Software License v. 3.0 (OSL-3.0)](http://opensource.org/licenses/osl-3.0.php).

src/main/resources/fileTemplates/code/GitHub New Bug Issue Body Template.txt.ft

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ If applicable, add screenshots to help explain your problem.
2525
**Please complete the following information:** (*)
2626

2727
#set($os = "#if(${OS_VERSION})${OS_VERSION}#else[e.g. MacOS or Ubuntu Linux 20.04]#end")
28-
#set($intellijVersion = "#if(${INTELLIJ_VERSION})${INTELLIJ_VERSION}#else[e.g. 2019.3.3]#end")
28+
#set($intellijVersion = "#if(${INTELLIJ_VERSION})${INTELLIJ_VERSION}#else[e.g. 2026.1]#end")
2929
#set($pluginVersion = "#if(${PLUGIN_VERSION})${PLUGIN_VERSION}#else[e.g. 1.0.0]#end")
3030
- OS: $os
3131
- PhpStorm/Intellij version: $intellijVersion

0 commit comments

Comments
 (0)