|
1 | | -# gateway-plugin |
2 | | - |
3 | | - |
4 | | -[](https://plugins.jetbrains.com/plugin/PLUGIN_ID) |
5 | | -[](https://plugins.jetbrains.com/plugin/PLUGIN_ID) |
6 | | - |
7 | | -## Template ToDo list |
8 | | -- [x] Create a new [IntelliJ Platform Plugin Template][template] project. |
9 | | -- [ ] Get familiar with the [template documentation][template]. |
10 | | -- [ ] Adjust the [pluginGroup](./gradle.properties), [plugin ID](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin). |
11 | | -- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description]) |
12 | | -- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate). |
13 | | -- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time. |
14 | | -- [ ] Set the `PLUGIN_ID` in the above README badges. |
15 | | -- [ ] 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). |
16 | | -- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate). |
17 | | -- [ ] 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. |
| 1 | +# OpenShift Dev Spaces Gateway Plugin |
| 2 | + |
| 3 | +[](https://github.com/redhat-developer/devspaces-gateway-plugin/actions/workflows/build.yml) |
| 4 | +[](https://plugins.jetbrains.com/plugin/com.github.devspaces.gateway) |
| 5 | +[](https://plugins.jetbrains.com/plugin/com.github.devspaces.gateway) |
18 | 6 |
|
19 | 7 | <!-- Plugin description --> |
20 | | -This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have. |
| 8 | +<!-- This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process. --> |
| 9 | +Plugin for JetBrains Gateway enables local desktop development experience with the IntelliJ IDEs connected to OpenShift Dev Spaces. |
| 10 | +<!-- Plugin description end --> |
21 | 11 |
|
22 | | -This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process. |
| 12 | +## Development |
| 13 | +- To test the plugin quickly against the Gateway instance bundled with the plugin, run: |
23 | 14 |
|
24 | | -To keep everything working, do not remove `<!-- ... -->` sections. |
25 | | -<!-- Plugin description end --> |
| 15 | +```console |
| 16 | +./gradlew runIde |
| 17 | +``` |
| 18 | + |
| 19 | +- To skip opening the Gateway main window and connect to an already running workspace with the IDEA dev server: |
| 20 | + |
| 21 | +```console |
| 22 | +./gradlew runIde --args="jetbrains-gateway://connect#type=devspaces&dwNamespace=john-che&dwName=my-ws" |
| 23 | +``` |
| 24 | + |
| 25 | +with replacing your DevWorkspace's namespace and name in `dwNamespace` and `dwName` parameters. |
| 26 | + |
| 27 | +### Building |
| 28 | +1. Run: |
| 29 | + |
| 30 | +```console |
| 31 | +./gradlew clean buildPlugin |
| 32 | +``` |
| 33 | + |
| 34 | +2. Find the built plugin in the `build/distributions` folder. |
| 35 | + |
| 36 | +### Installation |
| 37 | +In the Gateway, click the gear button <kbd>⚙️</kbd>, and choose `Manage Providers` to open the `Plugins` window. |
| 38 | + |
| 39 | +There're a couple of options to install the plugin: |
26 | 40 |
|
27 | | -## Installation |
| 41 | +- Search for "OpenShift Dev Spaces". |
| 42 | +- Click the gear button <kbd>⚙️</kbd> and choose `Install Plugin from Disk...`. Then, |
| 43 | + - choose the built plugin (zip) located at the `build/distributions` folder or |
| 44 | + - download the plugin from the [latest release](https://github.com/redhat-developer/devspaces-gateway-plugin/releases/latest) |
28 | 45 |
|
29 | | -- Using the IDE built-in plugin system: |
30 | | - |
31 | | - <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "gateway-plugin"</kbd> > |
32 | | - <kbd>Install</kbd> |
33 | | - |
34 | | -- Manually: |
| 46 | +### IntelliJ Plugin Verifier |
| 47 | +To check the plugin compatibility against the Gateway versions defined in the [gradle.properties](./gradle.properties) file. |
35 | 48 |
|
36 | | - Download the [latest release](https://github.com/che-incubator/gateway-plugin/releases/latest) and install it manually using |
37 | | - <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> |
| 49 | +```console |
| 50 | +./gradlew runPluginVerifier |
| 51 | +``` |
38 | 52 |
|
39 | 53 | ## Release |
40 | 54 | 1. Find a draft release on the [Releases](https://github.com/redhat-developer/devspaces-gateway-plugin/releases) page. The draft is created and updated automatically on each push to the `main` branch. |
|
0 commit comments