@eclipse-che/che-devworkspace-generator 0.0.1-4e80d1b → 0.0.1-4f0e375

package/README.md

@@ -1,28 +1,50 @@
 ## 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.
 
 ```
 USAGE
     $ node lib/entrypoint.js [OPTIONS]
 
 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
+
+      --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'
 
-    $ 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`
 ```
 
-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.
+
+If the DevWorkspace engine is installed on the cluster, the following command will create a DevWorkspace:
 
-`$ kubectl apply -f /tmp/all-in-one.yaml`
+`$ kubectl apply -f /tmp/devworkspace-che-code-latest.yaml`

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

@@ -80,7 +80,7 @@ var url_fetcher_1 = require("../fetch/url-fetcher");
 var PluginRegistryResolver = /** @class */ (function () {
     function PluginRegistryResolver() {
     }
-    // FQN id (like eclipse/che-theia/next)
+    // FQN id (like che-incubator/che-code/next)
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     PluginRegistryResolver.prototype.loadDevfilePlugin = function (devfileId) {
         return __awaiter(this, void 0, void 0, function () {

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

@@ -1 +1 @@
-{"version":3,"file":"plugin-registry-resolver.js","sourceRoot":"","sources":["../../src/plugin-registry/plugin-registry-resolver.ts"],"names":[],"mappings":";AAAA;;;;;;;;yEAQyE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEzE,8CAAkC;AAElC,uCAAsD;AAEtD,oDAAkD;AAElD;;GAEG;AAEH;IAAA;IAeA,CAAC;IAPC,uCAAuC;IACvC,8DAA8D;IACxD,kDAAiB,GAAvB,UAAwB,SAAiB;;;;;;wBACjC,UAAU,GAAM,IAAI,CAAC,iBAAiB,iBAAY,SAAS,kBAAe,CAAC;wBAC1D,qBAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,EAAA;;wBAA5D,cAAc,GAAG,SAA2C;wBAClE,sBAAO,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAC;;;;KACpC;IAXD;QAFC,IAAA,kBAAM,EAAC,QAAQ,CAAC;QAChB,IAAA,iBAAK,EAAC,qBAAqB,CAAC;6DACK;IAGlC;QADC,IAAA,kBAAM,EAAC,wBAAU,CAAC;sDACY;IANpB,sBAAsB;QADlC,IAAA,sBAAU,GAAE;OACA,sBAAsB,CAelC;IAAD,6BAAC;CAAA,AAfD,IAeC;AAfY,wDAAsB"}
+{"version":3,"file":"plugin-registry-resolver.js","sourceRoot":"","sources":["../../src/plugin-registry/plugin-registry-resolver.ts"],"names":[],"mappings":";AAAA;;;;;;;;yEAQyE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEzE,8CAAkC;AAElC,uCAAsD;AAEtD,oDAAkD;AAElD;;GAEG;AAEH;IAAA;IAeA,CAAC;IAPC,4CAA4C;IAC5C,8DAA8D;IACxD,kDAAiB,GAAvB,UAAwB,SAAiB;;;;;;wBACjC,UAAU,GAAM,IAAI,CAAC,iBAAiB,iBAAY,SAAS,kBAAe,CAAC;wBAC1D,qBAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,EAAA;;wBAA5D,cAAc,GAAG,SAA2C;wBAClE,sBAAO,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAC;;;;KACpC;IAXD;QAFC,IAAA,kBAAM,EAAC,QAAQ,CAAC;QAChB,IAAA,iBAAK,EAAC,qBAAqB,CAAC;6DACK;IAGlC;QADC,IAAA,kBAAM,EAAC,wBAAU,CAAC;sDACY;IANpB,sBAAsB;QADlC,IAAA,sBAAU,GAAE;OACA,sBAAsB,CAelC;IAAD,6BAAC;CAAA,AAfD,IAeC;AAfY,wDAAsB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-che/che-devworkspace-generator",
-  "version": "0.0.1-4e80d1b",
+  "version": "0.0.1-4f0e375",
   "private": false,
   "description": "Generates DevWorkspaces by transforming existing devfiles",
   "main": "lib/entrypoint.js",

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

@@ -26,7 +26,7 @@ export class PluginRegistryResolver {
   @inject(UrlFetcher)
   private urlFetcher: UrlFetcher;
 
-  // FQN id (like eclipse/che-theia/next)
+  // FQN id (like che-incubator/che-code/next)
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   async loadDevfilePlugin(devfileId: string): Promise<any> {
     const devfileUrl = `${this.pluginRegistryUrl}/plugins/${devfileId}/devfile.yaml`;