Skip to content

Commit 00da9c5

Browse files
committed
Prepare for publishing to Marketplace
Signed-off-by: Artem Zatsarynnyi <azatsary@redhat.com>
1 parent 92a0d79 commit 00da9c5

File tree

6 files changed

+52
-37
lines changed

6 files changed

+52
-37
lines changed

README.md

Lines changed: 44 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,54 @@
1-
# gateway-plugin
2-
3-
![Build](https://github.com/che-incubator/gateway-plugin/workflows/Build/badge.svg)
4-
[![Version](https://img.shields.io/jetbrains/plugin/v/PLUGIN_ID.svg)](https://plugins.jetbrains.com/plugin/PLUGIN_ID)
5-
[![Downloads](https://img.shields.io/jetbrains/plugin/d/PLUGIN_ID.svg)](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+
[![Build](https://github.com/redhat-developer/devspaces-gateway-plugin/workflows/Build/badge.svg)](https://github.com/redhat-developer/devspaces-gateway-plugin/actions/workflows/build.yml)
4+
[![Version](https://img.shields.io/jetbrains/plugin/v/com.github.devspaces.gateway.svg)](https://plugins.jetbrains.com/plugin/com.github.devspaces.gateway)
5+
[![Downloads](https://img.shields.io/jetbrains/plugin/d/com.github.devspaces.gateway.svg)](https://plugins.jetbrains.com/plugin/com.github.devspaces.gateway)
186

197
<!-- 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 -->
2111

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:
2314

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:
2640

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)
2845

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.
3548

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+
```
3852

3953
## Release
4054
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.

gradle.properties

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# IntelliJ Platform Artifacts Repositories -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html
22

33
pluginGroup = com.github.devspaces.gateway
4-
pluginName = gateway-plugin
4+
pluginName = devspaces-gateway-plugin
55
pluginRepositoryUrl = https://github.com/redhat-developer/devspaces-gateway-plugin
66
# SemVer format -> https://semver.org
77
pluginVersion = 0.0.2
88

99
# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
10-
pluginSinceBuild = 233
11-
pluginUntilBuild = 233.*
10+
pluginSinceBuild = 241
11+
pluginUntilBuild = 241.*
1212

1313
# IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
1414
platformType = GW
15-
platformVersion = 233.14475.30-CUSTOM-SNAPSHOT
15+
platformVersion = 241.14494.255-CUSTOM-SNAPSHOT
1616

1717
# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
1818
# Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22

settings.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ plugins {
22
id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
33
}
44

5-
rootProject.name = "gateway-plugin"
5+
rootProject.name = "devspaces-gateway-plugin"

src/main/resources/META-INF/plugin.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<vendor email="developers@redhat.com" url="https://www.redhat.com">Red-Hat</vendor>
66

77
<depends>com.intellij.modules.platform</depends>
8+
<depends optional="true">com.jetbrains.gateway</depends>
89

910
<resource-bundle>messages.DevSpacesBundle</resource-bundle>
1011

Lines changed: 1 addition & 1 deletion
Loading

src/main/resources/messages/DevSpacesBundle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ connector.title=Dev Spaces
66
connector.wizard_step.openshift_connection.title=Connecting to OpenShift API server
77
connector.wizard_step.openshift_connection.label.server=Server:
88
connector.wizard_step.openshift_connection.label.token=Token:
9-
connector.wizard_step.openshift_connection.button.previous=Exit
9+
connector.wizard_step.openshift_connection.button.previous=Back
1010
connector.wizard_step.openshift_connection.button.next=Check connection and continue
1111

1212
# Wizard selecting DevWorkspace step

0 commit comments

Comments
 (0)