@eclipse-che/che-devworkspace-generator - npm Package Compare versions

Comparing version 0.0.1-4e80d1b to 0.0.1-4f0e375

lib/plugin-registry/plugin-registry-resolver.js

@@ -83,3 +83,3 @@ "use strict";
     }
-    // FQN id (like eclipse/che-theia/next)
+    // FQN id (like che-incubator/che-code/next)
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -86,0 +86,0 @@ PluginRegistryResolver.prototype.loadDevfilePlugin = function (devfileId) {

package.json

 {
   "name": "@eclipse-che/che-devworkspace-generator",
-  "version": "0.0.1-4e80d1b",
+  "version": "0.0.1-4f0e375",
   "private": false,
@@ -5,0 +5,0 @@ "description": "Generates DevWorkspaces by transforming existing devfiles",

README.md

 ## DevWorkspace Generator
-The library is used by Devfile registry component to generate the DevWorkspace components and DevWorkspace templates.
+The library is used by Devfile registry component to generate the DevWorkspace components and DevWorkspace templates. It requires editor definitions from the 
+[che-plugin-registry](https://github.com/eclipse-che/che-plugin-registry/).
 
 ## How to use the library
-The library could be used as a standalone library.
+The library can be used as a standalone library.
 
@@ -12,18 +13,39 @@ ```
 OPTIONS
-      --devfile-path    path to the devfile.yaml file
-      --devfile-url     URL to the git repository that contains devfile.yaml 
-      --plugin-registry-url URL to the plugin registry that contains an editor's definition
-      --editor-entry    editor's ID 
-      --editor-path:    path to the editor's devfile.yaml file
-      --output-file path to the file where the generated content will be stored
-      --project.    describes project entry
+      --devfile-url:           URL to the git repository that contains devfile.yaml
+            or
+      --devfile-path:          path to the devfile.yaml file
 
-EXAMPLE
+      --plugin-registry-url:   URL to the plugin registry that contains editor definitions (devfile.yaml)
+      --editor-entry:          editor ID, found on the <plugin-registry-url>, to resolve the devfile.yaml
+            or
+      --editor-path:           local file path of the editor devfile.yaml
 
-    $ node lib/entrypoint.js --devfile-url:https://github.com/che-samples/java-spring-petclinic/tree/main --editor-entry:che-incubator/che-code/insiders --plugin-registry-url:https://che-plugin-registry-main.surge.sh/v3/ --output-file:/tmp/all-in-one.yaml`
+      --output-file:           local file path for the generated devworkspace yaml 
+
+      --project.<project-name> local file path for the sample project zip (for airgapped/offline registry builds)
+
+EXAMPLES
+
+    # online example, using editor definition from https://che-plugin-registry-main.surge.sh/
+
+    $ node lib/entrypoint.js \
+        --devfile-url:https://github.com/che-samples/java-spring-petclinic/tree/main \
+        --plugin-registry-url:https://che-plugin-registry-main.surge.sh/v3/ \
+        --editor-entry:che-incubator/che-code/latest \
+        --output-file:/tmp/devworkspace-che-code-latest.yaml`
+
+    # offline example with devfile.yaml files and zipped project available locally
+
+    $ node lib/entrypoint.js \
+        --devfile-path:/remote-source/python-hello-world/app/devfile.yaml \
+        --editor-path:/build/plugins/che-incubator/che-code/latest/devfile.yaml \
+        --output-file:./devfiles/python__python-hello-world/devworkspace-che-code-latest.yaml \
+        --project.python-hello-world='{{_INTERNAL_URL_}}/resources/v2/python-hello-world.zip'
+
 ```
 
-The file `/tmp/all-in-one.yaml` contains a DevWorkspace based on the repository devfile and a Che-Code DevWorkspaceTemplate.
-If DevWorkspace engine is available on the cluster, the following command will create a DevWorkspace:
+The output file `devworkspace-che-code-latest.yaml` contains a DevWorkspace based on the repository devfile and a Che-Code DevWorkspaceTemplate.
 
-`$ kubectl apply -f /tmp/all-in-one.yaml`
+If the DevWorkspace engine is installed on the cluster, the following command will create a DevWorkspace:
+
+`$ kubectl apply -f /tmp/devworkspace-che-code-latest.yaml`

src/plugin-registry/plugin-registry-resolver.ts

@@ -29,3 +29,3 @@ /**********************************************************************
 
-  // FQN id (like eclipse/che-theia/next)
+  // FQN id (like che-incubator/che-code/next)
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -32,0 +32,0 @@ async loadDevfilePlugin(devfileId: string): Promise<any> {

New alerts

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

112724

increased by0.89%

Number of lines in readme file

51

increased by75.86%

No dependency changes