Skip to content

Doc plugin structure, build, code quality and CI #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 27, 2022
Merged

Doc plugin structure, build, code quality and CI #19

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fbe417f
Add badges
fioan89 Jun 20, 2022
bcb9cc9
Improve plugin description
fioan89 Jun 20, 2022
b77c9af
Doc: add install steps
fioan89 Jun 20, 2022
9b7dc83
Merge branch 'main' into doc-build-and-release
fioan89 Jun 20, 2022
4e05026
Doc: plugin structure
fioan89 Jun 20, 2022
341073a
Doc: gradle properties
fioan89 Jun 20, 2022
636ac30
Doc: test & Qodana
fioan89 Jun 20, 2022
6b97f20
Doc: add a note about plugin verifier
fioan89 Jun 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Doc: gradle properties
  • Loading branch information
@fioan89
fioan89 committed Jun 20, 2022
commit 341073ae2f12ae009265766ac8f971975fb29bcc
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ To manually install a local build:
Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the one specified in `gradle.properties` - `platformVersion`) with the latest plugin changes deployed.

### Plugin Structure

```
.
├── .github/ GitHub Actions workflows and Dependabot configuration files
Expand All @@ -58,3 +59,23 @@ Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the
```

`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].

### Gradle Configuration Properties

The project-specific configuration file [gradle.properties][file:gradle.properties] contains:

| Property name | Description |
| --------------------------- |---------------------------------------------------------------------------------------------------------------|
| `pluginGroup` | Package name, set to `com.coder.gateway`. |
| `pluginName` | Zip filename. |
| `pluginVersion` | The current version of the plugin in [SemVer](https://semver.org/) format. |
| `pluginSinceBuild` | The `since-build` attribute of the `<idea-version>` tag. The minimum Gateway build supported by the plugin |
| `pluginUntilBuild` | The `until-build` attribute of the `<idea-version>` tag. Supported Gateway builds, until & not inclusive |
| `platformType` | The type of IDE distribution, in this GW. |
| `platformVersion` | The version of the Gateway used to build&run the plugin. |
| `platformDownloadSources` | Gateway sources downloaded while initializing the Gradle build. Note: Gateway does not have open sources |
| `platformPlugins` | Comma-separated list of dependencies to the bundled Gateway plugins and plugins from the Plugin Repositories. |
| `javaVersion` | Java language level used to compile sources and generate the files for - Java 11 is required since 2020.3. |
| `gradleVersion` | Version of Gradle used for plugin development. |

The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details.