https://github.com/redhat-developer/devspaces-gateway-plugin
JetBrains Gateway connector for OpenShift Dev Spaces / Eclipse Che
https://github.com/redhat-developer/devspaces-gateway-plugin
Last synced: about 1 month ago
JSON representation
JetBrains Gateway connector for OpenShift Dev Spaces / Eclipse Che
- Host: GitHub
- URL: https://github.com/redhat-developer/devspaces-gateway-plugin
- Owner: redhat-developer
- License: epl-2.0
- Created: 2024-01-17T15:29:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-18T13:53:28.000Z (7 months ago)
- Last Synced: 2025-06-18T14:40:12.763Z (7 months ago)
- Language: Kotlin
- Homepage: https://plugins.jetbrains.com/plugin/24234-openshift-dev-spaces
- Size: 2.01 MB
- Stars: 6
- Watchers: 16
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# OpenShift Dev Spaces Gateway Plugin
[](https://github.com/redhat-developer/devspaces-gateway-plugin/actions/workflows/build.yml)
[](https://plugins.jetbrains.com/plugin/24234-openshift-dev-spaces)
[](https://plugins.jetbrains.com/plugin/24234-openshift-dev-spaces)
Plugin for JetBrains Gateway enables local desktop development experience with the IntelliJ IDEs connected to OpenShift Dev Spaces.
## Feedback
We love to hear from users and developers.
You can ask questions, report bugs, and request features using [GitHub issues](https://github.com/eclipse/che/issues) in the Eclipse Che main repository.
## Development
- To test the plugin quickly against the Gateway instance bundled with the plugin, run:
```console
./gradlew runIde
```
- To skip opening the Gateway main window and connect to an already running workspace with the IDEA dev server:
```console
./gradlew runIde --args="jetbrains-gateway://connect#type=devspaces&dwNamespace=john-che&dwName=my-ws"
```
with replacing your DevWorkspace's namespace and name in `dwNamespace` and `dwName` parameters.
### Building
1. Run:
```console
./gradlew clean buildPlugin
```
2. Find the built plugin in the `build/distributions` folder.
### Installation
In the Gateway, click the gear button ⚙️, and choose `Manage Providers` to open the `Plugins` window.
There're a couple of options to install the plugin:
- Search for "OpenShift Dev Spaces".
- Click the gear button ⚙️ and choose `Install Plugin from Disk...`. Then,
- choose the built plugin (zip) located at the `build/distributions` folder, or
- download the plugin from the [latest release](https://github.com/redhat-developer/devspaces-gateway-plugin/releases/latest)
### IntelliJ Plugin Verifier
To check the plugin compatibility against the Gateway versions defined in the [gradle.properties](./gradle.properties) file.
```console
./gradlew runPluginVerifier
```
### Troubleshooting
1. To check the state of the port forwarding:
```console
sudo lsof -i -P | grep LISTEN | grep 5990
```
2. The Gateway application and the Dev Spaces plugin logs are stored in
`/Users//Library/Logs/JetBrains/JetBrainsGateway/idea.log`
## Release
- 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.
- Edit the draft:
- Click the `Generate release notes` button and edit the release notes if needed
- Click the `Publish release` button. The [Release](https://github.com/redhat-developer/devspaces-gateway-plugin/blob/main/.github/workflows/release.yml) Workflow will attach the built plugin artifact to the published release.
- Upload the plugin artifact to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/24234-openshift-dev-spaces/edit).
- Find the [`Changelog update - v0.0.x` PR](https://github.com/redhat-developer/devspaces-gateway-plugin/pulls), created automatically by the [Release](https://github.com/redhat-developer/devspaces-gateway-plugin/blob/main/.github/workflows/release.yml) Workflow, and merge it. Note that currently, it requires closing and reopening the PR to trigger the PR checks. As, due to some issue, they are hanging in a waiting state forever.
- Bump the `pluginVersion` in the [gradle.properties](https://github.com/redhat-developer/devspaces-gateway-plugin/blob/main/gradle.properties) file.
---
Plugin based on the [IntelliJ Platform Plugin Template][template].
[template]: https://github.com/JetBrains/intellij-platform-plugin-template
[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation