You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-8
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,6 @@ Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the
36
36
### Plugin Structure
37
37
38
38
```
39
-
.
40
39
├── .github/ GitHub Actions workflows and Dependabot configuration files
41
40
├── gradle
42
41
│ └── wrapper/ Gradle Wrapper
@@ -58,11 +57,11 @@ Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the
58
57
└── settings.gradle.kts Gradle project settings
59
58
```
60
59
61
-
`src` directory is the most important part of the project, the Coder Gateway implementation and the manifest for the plugin – [plugin.xml][file:plugin.xml].
60
+
`src` directory is the most important part of the project, the Coder Gateway implementation and the manifest for the plugin – [`plugin.xml`](src/main/resources/META-INF/plugin.xml).
62
61
63
62
### Gradle Configuration Properties
64
63
65
-
The project-specific configuration file [gradle.properties][file:gradle.properties] contains:
64
+
The project-specific configuration file [`gradle.properties`](gradle.properties) contains:
@@ -78,7 +77,7 @@ The project-specific configuration file [gradle.properties][file:gradle.properti
78
77
|`javaVersion`| Java language level used to compile sources and generate the files for - Java 11 is required since 2020.3. |
79
78
|`gradleVersion`| Version of Gradle used for plugin development. |
80
79
81
-
The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details.
80
+
The properties listed define the plugin itself or configure the [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin) – check its documentation for more details.
82
81
83
82
### Testing
84
83
@@ -91,18 +90,18 @@ Code quality is monitored with the help of [Qodana](https://www.jetbrains.com/qo
91
90
Qodana inspections are accessible within the project on two levels:
92
91
93
92
- using the [Qodana IntelliJ GitHub Action][docs:qodana-github-action], run automatically within the [Build](.github/workflows/build.yml) workflow,
94
-
- with the [Gradle Qodana Plugin][gh:gradle-qodana-plugin], so you can use it on the local environment or any CI other than GitHub Actions.
93
+
- with the [Gradle Qodana Plugin](https://github.com/JetBrains/gradle-qodana-plugin), so you can use it on the local environment or any CI other than GitHub Actions.
95
94
96
-
Qodana inspection is configured with the `qodana { ... }` section in the [Gradle build file][file:build.gradle.kts] and [`qodana.yml`][file:qodana.yml] YAML configuration file.
95
+
Qodana inspection is configured with the `qodana { ... }` section in the [Gradle build file](build.gradle.kts) and [`qodana.yml`](qodana.yml) YAML configuration file.
97
96
98
97
> **NOTE:** Qodana requires Docker to be installed and available in your environment.
99
98
100
99
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.
101
100
102
101
A final report is available in the `./build/reports/inspections/` directory.
103
102
104
-
![Qodana][file:qodana.png]
103
+

105
104
106
105
### Plugin compatibility
107
106
108
-
`./gradlew runPluginVerifier` can check the plugin compatibility against the specified Gateway. The integration with Githug Actions is commented until [this gradle intellij plugin issue](https://github.com/JetBrains/gradle-intellij-plugin/issues/1027) is fixed.
107
+
`./gradlew runPluginVerifier` can check the plugin compatibility against the specified Gateway. The integration with Github Actions is commented until [this gradle intellij plugin issue](https://github.com/JetBrains/gradle-intellij-plugin/issues/1027) is fixed.
0 commit comments