@eclipse-che/che-devworkspace-generator 0.0.1-25f630b → 0.0.1-bd2d989
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
## DevWorkspace Generator
|
|
2
|
+
The library is used by Devfile registry component to generate the DevWorkspace components and DevWorkspace templates.
|
|
3
|
+
|
|
4
|
+
## How to use the library
|
|
5
|
+
The library could be used as a standalone library.
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
USAGE
|
|
9
|
+
$ node lib/entrypoint.js [OPTIONS]
|
|
10
|
+
|
|
11
|
+
OPTIONS
|
|
12
|
+
--devfile-path path to the devfile.yaml file
|
|
13
|
+
--devfile-url URL to the git repository that contains devfile.yaml
|
|
14
|
+
--plugin-registry-url URL to the plugin registry that contains an editor's definition
|
|
15
|
+
--editor-entry editor's ID
|
|
16
|
+
--editor-path: path to the editor's devfile.yaml file
|
|
17
|
+
--output-file path to the file where the generated content will be stored
|
|
18
|
+
--project. describes project entry
|
|
19
|
+
|
|
20
|
+
EXAMPLE
|
|
21
|
+
|
|
22
|
+
$ 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`
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The file `/tmp/all-in-one.yaml` contains a DevWorkspace based on the repository devfile and a Che-Code DevWorkspaceTemplate.
|
|
26
|
+
If DevWorkspace engine is available on the cluster, the following command will create a DevWorkspace:
|
|
27
|
+
|
|
28
|
+
`$ kubectl apply -f /tmp/all-in-one.yaml`
|
package/package.json
CHANGED