Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 341073a

Browse files
committedJun 20, 2022
Doc: gradle properties
1 parent 4e05026 commit 341073a

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed
 

‎README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ To manually install a local build:
3434
Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the one specified in `gradle.properties` - `platformVersion`) with the latest plugin changes deployed.
3535

3636
### Plugin Structure
37+
3738
```
3839
.
3940
├── .github/ GitHub Actions workflows and Dependabot configuration files
@@ -58,3 +59,23 @@ Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the
5859
```
5960

6061
`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].
62+
63+
### Gradle Configuration Properties
64+
65+
The project-specific configuration file [gradle.properties][file:gradle.properties] contains:
66+
67+
| Property name | Description |
68+
| --------------------------- |---------------------------------------------------------------------------------------------------------------|
69+
| `pluginGroup` | Package name, set to `com.coder.gateway`. |
70+
| `pluginName` | Zip filename. |
71+
| `pluginVersion` | The current version of the plugin in [SemVer](https://semver.org/) format. |
72+
| `pluginSinceBuild` | The `since-build` attribute of the `<idea-version>` tag. The minimum Gateway build supported by the plugin |
73+
| `pluginUntilBuild` | The `until-build` attribute of the `<idea-version>` tag. Supported Gateway builds, until & not inclusive |
74+
| `platformType` | The type of IDE distribution, in this GW. |
75+
| `platformVersion` | The version of the Gateway used to build&run the plugin. |
76+
| `platformDownloadSources` | Gateway sources downloaded while initializing the Gradle build. Note: Gateway does not have open sources |
77+
| `platformPlugins` | Comma-separated list of dependencies to the bundled Gateway plugins and plugins from the Plugin Repositories. |
78+
| `javaVersion` | Java language level used to compile sources and generate the files for - Java 11 is required since 2020.3. |
79+
| `gradleVersion` | Version of Gradle used for plugin development. |
80+
81+
The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details.

0 commit comments

Comments
 (0)
Please sign in to comment.