Skip to content

redhat-developer/devspaces-gateway-plugin

Repository files navigation

OpenShift Dev Spaces Gateway Plugin

Build Version Downloads

Plugin for JetBrains Gateway enables local desktop development experience with the IntelliJ IDEs connected to OpenShift Dev Spaces.

Development

  • To test the plugin quickly against the Gateway instance bundled with the plugin, run:
./gradlew runIde
  • To skip opening the Gateway main window and connect to an already running workspace with the IDEA dev server:
./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:
./gradlew clean buildPlugin
  1. 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

IntelliJ Plugin Verifier

To check the plugin compatibility against the Gateway versions defined in the gradle.properties file.

./gradlew runPluginVerifier

Troubleshooting

To check the state of the port forwarding:

sudo lsof -i -P | grep LISTEN | grep 5990

Release

  1. Find a draft release on the Releases page. The draft is created and updated automatically on each push to the main branch.
  2. Edit the draft and use the Publish release button. The Release Workflow will attach the built plugin artifact to the published release.
  3. Upload the plugin artifact to Jet Brains Marketplace.
  4. Find the Changelog update PR, created automatically by the Release Workflow, and merge it.
  5. Update the pluginVersion in the gradle.properties file.

Plugin based on the IntelliJ Platform Plugin Template.