Skip to content

Commit 1d86bcc

Browse files
committed
che #14357: Adding build status icons and info about existing CI jobs to README
Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>
1 parent 3567e76 commit 1d86bcc

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
1+
[![Master Build Status](https://ci.centos.org/buildStatus/icon?subject=master&job=devtools-che-machine-exec-build-master/)](https://ci.centos.org/job/devtools-che-machine-exec-build-master/)
2+
[![Nightly Build Status](https://ci.centos.org/buildStatus/icon?subject=nightly&job=devtools-che-machine-exec-nightly)](https://ci.centos.org/job/devtools-che-machine-exec-nightly/)
3+
[![Release Build Status](https://ci.centos.org/buildStatus/icon?subject=release&job=devtools-che-machine-exec-release/)](https://ci.centos.org/job/devtools-che-machine-exec-release/)
4+
15
# CHE machine exec
26

37
Go-lang server side to creation machine-execs for Eclipse CHE workspaces.
48
Uses to spawn terminal or command processes.
59

610
CHE machine exec uses json-rpc protocol to communication with client.
711

8-
# Build docker image
12+
## Build docker image
913

1014
Build docker image with che-machine-exec manually:
1115

1216
```bash
1317
docker build --no-cache -t eclipse/che-machine-exec .
1418
```
1519

16-
# Run docker container
20+
## Run docker container
1721

1822
Run docker container with che-machine-exec manually:
1923

2024
```bash
2125
docker run --rm -p 4444:4444 -v /var/run/docker.sock:/var/run/docker.sock eclipse/che-machine-exec
2226
```
2327

24-
# How to use machine-exec image with Eclipse CHE workspace on the docker infrastructure
28+
## How to use machine-exec image with Eclipse CHE workspace on the docker infrastructure
2529

2630
To configure Eclipse CHE on the docker infrastructure we are using che.env configuration file.
2731
che.env file located in the CHE `data` folder. Edit and save che.env file: apply docker.sock path (by default it's `/var/run/docker.sock`) to the workspace volume property `CHE_WORKSPACE_VOLUME`:
@@ -36,7 +40,7 @@ CHE_WORKSPACE_VOLUME=/var/run/docker.sock:/var/run/docker.sock;
3640

3741
Run Eclipse CHE. You can create new Eclipse CHE workspace with integrated Theia IDE from stack 'Theia IDE on docker'. Then you can [test che-machine-exec with help eclipse-che-theia-terminal](#test-che-machine-exec-with-help-eclipse-che-theia-terminal) and [test che-machine-exec with help che-theia-task-plugin](#test-che-machine-exec-with-help-che-theia-task-plugin)
3842

39-
# Test che-machine-exec on the local Openshift
43+
## Test che-machine-exec on the local Openshift
4044

4145
To test che-machine-exec you need deploy Eclipse CHE to the openshift locally. [Prepare Eclipse CHE to deploy](#prepare-eclipse-che-to-deploy)
4246

@@ -61,7 +65,7 @@ the Eclipse CHE user dashboard.
6165

6266
Create new workspace from openshift stack 'Java Theia on OpenShift' or 'CHE 7' stack. Run workspace. When workspace will be running you will see Theia IDE. Then you can [test che-machine-exec with help che-theia-terminal-extension](#test-che-machine-exec-with-help-eclipse-che-theia-terminal) and [test che-machine-exec with help che-theia-task-plugin](#test-che-machine-exec-with-help-che-theia-task-plugin)
6367

64-
# Test on the Minishift
68+
## Test on the Minishift
6569
To test che-machine-exec you need deploy Eclipse CHE to the Minishift. [Prepare Eclipse CHE to deploy](#prepare-eclipse-che-to-deploy).
6670

6771
Install minishift with help this instractions:
@@ -127,7 +131,7 @@ export CHE_INFRA_KUBERNETES_MASTER__URL=${CHE_INFRA_KUBERNETES_MASTER__URL} && .
127131
Create new workspace from openshift stack 'Java Theia on OpenShift' or
128132
'CHE 7' stack. Run workspace. When workspace will be running you will see Theia IDE. Then you can [test che-machine-exec with help che-theia-terminal-extension](#test-che-machine-exec-with-help-eclipse-che-theia-terminal) and [test che-machine-exec with help che-theia-task-plugin](#test-che-machine-exec-with-help-che-theia-task-plugin)
129133

130-
# Test on the Kubernetes (MiniKube)
134+
## Test on the Kubernetes (MiniKube)
131135

132136
To test che-machine-exec you need deploy Eclipse CHE to the Minikube cluster. [Prepare Eclipse CHE to deploy](#prepare-eclipse-che-to-deploy).
133137

@@ -190,7 +194,7 @@ There are two configurations to deploy Eclipse CHE on the Kubernetes:
190194

191195
Create new workspace from stack 'CHE 7'. Run workspace. When workspace will be running you will see Theia IDE. Then you can [test che-machine-exec with help che-theia-terminal-extension](#test-che-machine-exec-with-help-eclipse-che-theia-terminal) and [test che-machine-exec with help che-theia-task-plugin](#test-che-machine-exec-with-help-che-theia-task-plugin)
192196

193-
# Prepare Eclipse CHE to deploy
197+
## Prepare Eclipse CHE to deploy
194198

195199
> Requiements: installed java 8 or higher and maven 3.3.0 or higher
196200

@@ -207,13 +211,13 @@ $ cd ~/projects/che/assembly/assembly-main
207211
$ mvn clean install -DskipTests
208212
```
209213
210-
# Test che-machine-exec with help eclipse-che-theia-terminal
214+
## Test che-machine-exec with help eclipse-che-theia-terminal
211215
Eclipse CHE workspace created from Theia stack contains included che-theia-terminal-extension. With help this extension you can test che-machine-exec.
212216
213217
Create new terminal with help main menu of the Theia: `Terminal` => `Open Terminal in specific container`. After that IDE will propose you select machine to creation terminal. Select one of the machines by click. After that Theia should create new terminal on the bottom panel.
214218
Or you could use command palette: `Ctrl + Shift + P` and type `terminal`. Then you could select with help keys `Arrow Up` or `Arrow Down` command for terminal creation and launch it by click on `Enter`.
215219
216-
# Test che-machine-exec with help che-theia-task-plugin
220+
## Test che-machine-exec with help che-theia-task-plugin
217221
218222
Eclipse CHE workspace created from Theia stack contains included che-theia-task-plugin. With help this plugin you can test che-machine-exec.
219223
Create new Theia task for your project: in the project root create folder `.theia`. Create `tasks.json` file in the folder `.theia` with such content:
@@ -231,3 +235,10 @@ Create new Theia task for your project: in the project root create folder `.thei
231235
```
232236
Run this task with help menu tasks: `Terminal` => `Run Task...`
233237
After that Theia should display widget with output content: 'echo hello'
238+
239+
## CI
240+
The following [CentOS CI jobs](https://ci.centos.org/) are associated with the repository:
241+
242+
- [![Master Build Status](https://ci.centos.org/buildStatus/icon?subject=master&job=devtools-che-machine-exec-build-master/)](https://ci.centos.org/job/devtools-che-machine-exec-build-master/) - builds CentOS images on each commit to the [`master`](https://github.com/eclipse/che-machine-exec/tree/master) branch and pushes them to [quay.io](https://quay.io/organization/eclipse).
243+
- [![Nightly Build Status](https://ci.centos.org/buildStatus/icon?subject=nightly&job=devtools-che-machine-exec-nightly)](https://ci.centos.org/job/devtools-che-machine-exec-nightly/) - builds CentOS images and pushes them to [quay.io](https://quay.io/organization/eclipse) on a daily basis from the [`master`](https://github.com/eclipse/che-machine-exec/tree/master) branch.
244+
- [![Release Build Status](https://ci.centos.org/buildStatus/icon?subject=release&job=devtools-che-machine-exec-release/)](https://ci.centos.org/job/devtools-che-machine-exec-release/) - builds images from the [`release`](https://github.com/eclipse/che-machine-exec/tree/release) branch and pushes them to [quay.io](https://quay.io/organization/eclipse).

0 commit comments

Comments
 (0)