Define a common IDE

Define a common IDE for all workspaces in a Git repository by using a che-editor.yaml file so that all team members and new contributors use the most suitable IDE for the project. You can also use this file to override the OpenShift Dev Spaces instance default IDE for a particular Git repository.

Before you begin

  • You have a project source code repository hosted on a Git provider.

About this task

To use an IDE other than the default Microsoft Visual Studio Code - Open Source for most or all workspaces in your organization, an administrator can set .spec.devEnvironments.defaultEditor in the CheCluster Custom Resource to apply the change at the instance level.

Procedure

In the remote Git repository of your project source code, create a /.che/che-editor.yaml file with lines that specify the relevant parameter. For example: 
id: che-incubator/che-code/latest

Results

  1. Start a new workspace with a clone of the Git repository.
  2. Verify that the specified IDE loads in the browser tab of the started workspace.