SDawley / che-code

Upstream Code OSS integration for Eclipse Che

che-code

Deploy Code-OSS on a kubernetes cluster and connect with your Browser.

This repository is hosting the changes to have the Code-OSS running inside a Browser and connecting to a remote HTTP(s) server (instead of using Desktop mode).

The terminal is aware of the running Pod. Then, you can open terminals in every container of the running pod (if the containers have shell access).

Upstream Code-OSS is stored using Git subtree. It means that if you're not interested in updating/rebasing upstream code you don't need to setup anything else unlike git submodules. This repository is self-contained.

Development pre-requisites

• NodeJS version used by Code-OSS (Exact version can be find inside https://github.com/microsoft/vscode/blob/main/remote/.yarnrc with target property)
• Yarn v1.x

Directories layout

• code contains the upstream content (subtree) + changes required to have Code running in a remote server.
• build/dockerfiles are for building a container.
• package.json holds some top-level scripts that you can find also in the code folder.

Development mode

1. Fetch dependencies with yarn command
2. Compile and watch folders: yarn run watch
3. Run the server (another terminal for example): yarn run server

Image build

1. docker build -f build/dockerfiles/linux-musl.Dockerfile -t linux-musl-amd64 .
2. docker build -f build/dockerfiles/linux-libc.Dockerfile -t linux-libc-amd64 .
3. export DOCKER_BUILDKIT=1
4. docker build -f build/dockerfiles/assembly.Dockerfile -t che-code .

Developing with Eclipse Che

This project includes Devfile that simplifies developing Che-Code in Eclipse Che. To test your changes in Eclipse Che run the following VS Code Tasks:

1. prepare to download all the required dependencies
2. build to pre-build and start the watch mode
3. run to run the VS Code server
4. Follow the suggested URL to test your changes.

Updates and branches

This repository has a main branch being rebased on the main remote branch of Code-OSS. Then, for each stable version of Code-OSSthere is a matching branch. For example remote release/1.60 is handled locally as a 1.62.x branch.

Pulling/Diff against new Code OSS version - useful commands

Add the Code-OSS remote by using for example the following command:

$ git remote add upstream-code https://github.com/microsoft/vscode

Pull changes from the remote Code

For a release branch:

$ git subtree pull --prefix code upstream-code release/1.62

For the main branch:

$ git subtree pull --prefix code upstream-code main

Check the diff between local and remote

For a release branch:

$ git diff upstream-code/release/1.62 1.62.x:code

For a main branch:

$ git diff upstream-code/main main:code

How to fix the rebase-insiders Workflow?

Upstream VS Code changes may bring a breakage to Che-Code. In this case, the rebase-insiders Workflow run is failed. To fix it, follow the steps below:

1. Checkout to a new branch, e.g.fix-rebase.
2. Fetch the latest changes from the upstream:

git remote add upstream-code https://github.com/microsoft/vscode
git fetch upstream-code main

3. ./rebase.sh
4. Fix the conflicts or other errors. Note, that./rebase.sh script also apllies the patches from the .rebase directory. Sometimes, it also requires some updates there.
5. Open a PR with your changes.

Whitelabel/branding

There is a functionality to apply branding to some UI elements. The original data can be overridden by executing the branding.sh script. The script searches for the branding resources in the branding folder.

The branding/product.json file is crucial. The values defined in the branding/product.json file override the default values. Also the file serves data mapping for provided branding resources.

Example of the branding/product.json file:

{
	"nameShort": "VS Code - Open Source",
	"nameLong": "Red Hat OpenShift Dev Spaces with Microsoft Visual Studio Code - Open Source IDE",
	"icons": {
		"favicon": {
			"universal": "icons/favicon.ico"
		},
		"welcome": {
			"universal": "icons/dev-spaces.svg"
		},
		"statusBarItem": {
			"universal": "icons/dev-spaces.svg"
		},
		"letterpress": {
			"light": "icons/letterpress-light.svg",
			"dark": "icons/letterpress-light.svg"
		}
	},
	"remoteIndicatorCommands": {
		"openDocumentationCommand": "Dev Spaces: Open Documentation",
		"openDashboardCommand": "Dev Spaces: Open Dashboard",
		"stopWorkspaceCommand": "Dev Spaces: Stop Workspace"
	},
	"workbenchConfigFilePath": "workbench-config.json",
	"codiconCssFilePath": "css/codicon.css"
}

• nameShort - The application name.
• nameLong - This is used for the Welcome page, the About dialog, and browser tab title.
• favicon - The icon for the browser tab title. It's the same for all themes.
• welcome - The icon for the Welcome (Get Started) page tab title. It's the same for all themes.
• statusBarItem - The icon for the status bar item. It's the same for all themes and must be defined as codicon in the workbench-config.json file and the codicon CSS styles.
• letterpress - The icon for the main area when all editors are closed. It's possible to provide different icons for light and dark themes.
• remoteIndicatorCommands - The names of commands provided by the Eclipse Che Remote extension.
• workbenchConfigFilePath - The config file path. See an example of the config file.
• codiconCssFilePath - The codicon css file path. Must contain CSS styles for codicons. The content of the file is appended to the coressponding css file. See an example of the content.

NOTE:

• All paths in the branding/product.json file must be relative to the branding folder. For example, the workbenchConfigFilePath field might have the anyFolder/myConfigFiles/workbench-config.json value. This means that the config file can be found by the path: che-code/branding/anyFolder/myConfigFiles/workbench-config.json
• Currently, the branding.sh script is not run automatically when building this project. It needs to be integrated into the build process of the downstream branded project or product.

Builds

This repo contains several actions, including:

• 
• 

Downstream builds can be found at the link below, which is internal to Red Hat. Stable builds can be found by replacing the 3.x with a specific version like 3.2.

• code_3.x

License

• Eclipse Public License 2.0