Gitpod Configuration (SchemaStore) JSON Schema

Type	object
File match	`.gitpod.yml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/gitpod-configuration/latest.json
Source	https://gitpod.io/schemas/gitpod-schema.json

ports object[]

List of exposed ports.

tasks object[]

List of tasks to run on start. Each task will open a terminal in the IDE.

image object | string

The Docker image to run your workspace in.

Default: "gitpod/workspace-full"

2 nested properties

file string required

Relative path to a docker file.

context string

Relative path to the context path (optional). Should only be set if you need to copy files into the image.

additionalRepositories object[]

List of additional repositories that are part of this project.

mainConfiguration string

The main repository, containing the dev environment configuration.

checkoutLocation string

Path to where the repository should be checked out relative to /workspace. Defaults to the simple repository name.

workspaceLocation string

Path to where the IDE's workspace should be opened. Supports vscode's *.code-workspace files.

gitConfig Record<string, string>

Git config values should be provided in pairs. E.g. core.autocrlf: input. See https://git-scm.com/docs/git-config#_values.

github object

Configures Gitpod's GitHub app (deprecated)

1 nested properties

prebuilds boolean | object

Set to true to enable workspace prebuilds, false to disable them. Defaults to true. (deprecated)

7 nested properties

master boolean

Enable prebuilds for the default branch (typically master). Defaults to true.

branches boolean

Enable prebuilds for all branches. Defaults to false.

pullRequests boolean

Enable prebuilds for pull-requests from the original repo. Defaults to true.

pullRequestsFromForks boolean

Enable prebuilds for pull-requests from any repo (e.g. from forks). Defaults to false.

addBadge boolean

Add a Review in Gitpod badge to pull requests. Defaults to true.

addCheck boolean | string

Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true.

Values: true false "prevent-merge-on-error"

addLabel boolean | string

Add a label to a PR when it's prebuilt. Set to true to use the default label (prebuilt-in-gitpod) or set to a string to use a different label name. This is a beta feature and may be unreliable. Defaults to false.

vscode object

Configure VS Code integration

1 nested properties

extensions string[]

List of extensions which should be installed for users of this workspace. The identifier of an extension is always '${publisher}.${name}'. For example: 'vscode.csharp'.

jetbrains object

Configure JetBrains integration

10 nested properties

plugins string[]

List of plugins which should be installed for all JetBrains product for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

intellij object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

goland object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

pycharm object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

phpstorm object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

rubymine object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

webstorm object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

rider object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

clion object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

rustrover object

3 nested properties

plugins string[]

List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

prebuilds object

Enable warming up of JetBrains backend in prebuilds.

1 nested properties

version string

Whether only stable, latest or both versions should be warmed up. Default is stable only.

Values: "stable" "latest" "both"

vmoptions string

Configure JVM options, for instance '-Xmx=4096m'.

experimentalNetwork boolean

Experimental network configuration in workspaces (deprecated). Enabled by default

coreDump object

Configure the default action of certain signals is to cause a process to terminate and produce a core dump file, a file containing an image of the process's memory at the time of termination. Disabled by default.

3 nested properties

enabled boolean

softLimit number

upper limit on the size of the core dump file that will be produced if it receives a core dump signal

hardLimit number

the hard limit acts as a ceiling for the soft limit. For more details please check https://man7.org/linux/man-pages/man2/getrlimit.2.html

env Record<string, string>

Environment variables to set on the workspace.

Gitpod Configuration

Validate with Lintel

Properties

Definitions