.gitpod.yml Reference

The .gitpod.yml file at the root of your project is where you tell Gitpod how to prepare & build your project, start development servers and configure continuous prebuilds for GitHub.

Below is a full reference of all available properties. To see the underlying schema, please refer to gitpod-io/gitpod in the gitpod-io/gitpod repository.

• .gitpod.yml Reference
  • additionalRepositories
  • checkoutLocation
  • gitConfig
  • github
    • prebuilds.addBadge
    • prebuilds.addCheck
    • prebuilds.addComment
    • prebuilds.addLabel
    • prebuilds.branches
    • prebuilds.master
    • prebuilds.pullRequests
    • prebuilds.pullRequestsFromForks
  • image
    • image.file
    • image.context
  • jetbrains
    • jetbrains.plugins
    • jetbrains.[product]
    • jetbrains.[product].plugins
    • jetbrains.[product].prebuilds
    • jetbrains.[product].vmoptions
  • mainConfiguration
  • ports
    • ports[n].name
    • ports[n].description
    • ports[n].onOpen
    • ports[n].port
    • ports[n].visibility
  • tasks
    • tasks[n].before
    • tasks[n].command
    • tasks[n].env
    • tasks[n].init
    • tasks[n].name
    • tasks[n].openIn
    • tasks[n].openMode
    • tasks[n].prebuild
  • vscode
    • vscode.extensions
  • workspaceLocation

additionalRepositories

additionalRepositories is currently in Beta. Send feedback.

Defines additional source control repositories to clone and where the repository is cloned under /workspaces

Demo

Example

When the above configuration is defined then the following additional steps happen when Gitpod workspace is started:

1. If you open a workspace on a branch, Gitpod will clone the same-named branch in all repositories. If such a branch doesn’t exist Gitpod checks out the default branch.
2. The contents of the branch is cloned under /workspaces/
3. The contents of https://github.com/gitpod-io/demo-multi-repo-backend is cloned to /workspaces/backend

After all of the source control repositories have been cloned then the before, init and command tasks are executed as per normal.

If you need to run commands (such as package installation or compilation) on the source control repositories which have been cloned then change your working directory to the use configured or default checkoutLocation location using the before task.

Example

checkoutLocation

Define where Gitpod checks out the project’s code, relative to /workspace.

In most cases, this is not needed. If you work on an older Go project, please see Checkout and Workspace Location for more details.

Example

gitConfig

Define a workspace’s git configuration as key-value pairs.

Please refer to https://git-scm.com/docs/git-config#_values for a list of accepted values.

Example

github

Configure the GitHub Gitpod app. At this time, the following configuration is used to configure continuous prebuilds for GitHub repositories.

Example

prebuilds.addBadge

Gitpod can modify the description of a pull request to add an “Open in Gitpod” button. This approach produces fewer GitHub notifications than adding a comment, but can also create a concurrent editing conflict when the bot and a user try to edit the description of a pull request at the same time.

prebuilds.addCheck

Configure whether Gitpod registers itself as a status check to pull requests - much like a continuous integration system would do. By default a failing prebuild would not make the check fail. Set prevent-merge-on-error to block PR merging when prebuilds failed.

To learn more about status checks, please see the GitHub documentation about status checks.

prebuilds.addComment

Gitpod can add a comment with an “Open in Gitpod” button to your pull requests. Alternatively, you could add a badge to the pull request’s description.

prebuilds.addLabel

Deprecated.

prebuilds.branches

Define whether Gitpod creates prebuilds for all branches.

prebuilds.master

Define whether Gitpod creates prebuilds for the default branch.

prebuilds.pullRequests

Define whether Gitpod creates prebuilds for pull requests from the original repository.

prebuilds.pullRequestsFromForks

Define whether Gitpod creates prebuilds for pull requests from forks.

image

Define a custom Docker image to be used for workspaces. To learn more, please review Custom Docker Image.

Public images are hosted on Docker Hub and can be referenced by their name, e.g. ubuntu:latest.

To see a list of Gitpod-provided images, please see gitpod-io/workspace-images.

Examples

With a public image

With a custom image

With an optional context

image.file

To define a custom Docker image, you can use the following configuration:

For a list of examples, please see https://github.com/gitpod-io/workspace-images.

image.context

Optionally, you can set the image.context. This is useful when you want to copy files into the Docker image. The Docker docs describe this in more detail.

jetbrains

JetBrains is currently in Beta · Send feedback.

Define the integration between Gitpod and JetBrains IDEs.

jetbrains.plugins

JetBrains plugin support (via gitpod.yml) is currently in Beta · Send feedback.

Define a list of plugins which should be installed for all compatible JetBrains IDEs when starting a workspace. To find the plugin identifier, from the JetBrains Marketplace, find the desired plugin, open the ‘Versions’ tab, select any version and copy the ‘Plugin ID’ (like ${publisher}.${name}).

jetbrains.[product]

JetBrains is currently in Beta · Send feedback.

Define the integration between Gitpod and a specific JetBrains IDE. Install plugins and configure prebuilds to speed up the IDE indexing.

Specify the ‘product’ with one of the following values:

• intellij
• goland
• pycharm
• phpstorm

jetbrains.[product].plugins

JetBrains plugin support (via gitpod.yml) is currently in Beta · Send feedback.

Define a list of plugins which should be installed for the given JetBrains IDE when starting a workspace. To find the plugin identifier, from the JetBrains Marketplace, find the desired plugin, open the ‘Versions’ tab, select any version and copy the ‘Plugin ID’ (like ${publisher}.${name}).

Example

jetbrains.[product].prebuilds

JetBrains prebuilds support (via gitpod.yml) is currently in Alpha · Send feedback.

Define whether Gitpod enables prebuilds for a specific JetBrains IDE.

Example

The version is defined as follows:

jetbrains.[product].vmoptions

Configuration of JVM options (via gitpod.yml) is currently in Alpha · Send feedback.

Configure JVM options for a specific JetBrains IDE.

Example

ports

Configure how Gitpod treats various ports your application may listen on. You can learn more about this in the Exposing Ports documentation.

Example

ports[n].name

Define a name for the port, will be shown as a column in the output of gp ports list and as a title of port in the Remote Explorer under the VS Code Browser sidebar. More detail

ports[n].description

Adds a description to the port, will be shown as a column in the output of gp ports list and as a tooltip (on hover) of the port in the Remote Explorer in VS Code Browser sidebar.

ports[n].onOpen

Define what to do when Gitpod detects a given port is being listened on.

Please note: For JetBrains IDEs connected to Gitpod via JetBrains Gateway open-preview will behave exactly the same as open-browser, as there is no functionality for a web preview in the JetBrains IDE.

ports[n].port

Define a single port or a range of ports, e.g. 3000-3100.

ports[n].visibility

Define whether to expose the port publicly or keep it private.

A public port allows you to share a URL for a given port with team members, for example if you want to get their feedback on a new feature you develop.

tasks

Define how Gitpod prepares & builds your project and how it can start the project’s development server(s). To learn more, please visit Start Tasks. Each array element opens in its own terminal.

Example

tasks[n].before

A shell command to run before init and the main command. This command is executed on every start and is expected to terminate. If it fails, the following commands will not be executed.

Learn more about Start Tasks in the docs.

tasks[n].command

The main shell command to run after before and init. This command is executed last on every start and doesn’t have to terminate.

Learn more about Start Tasks in the docs.

tasks[n].env

Define environment variables that will be available in the workspace.

Learn more about Environment Variables in the docs.

tasks[n].init

A shell command to run between before and the main command.

This task is executed only once. When you start a workspace that does not have a prebuild, init is executed at workspace start. When you start a workspace that has a prebuild, init executes as part of the prebuild, but does NOT execute again at workspace start.

This task is expected to terminate. If it fails, the command property will not be executed.

Learn more about Start Tasks in the docs.

tasks[n].name

A name for the task, also shown on the terminal tab.

tasks[n].openIn

Deprecated. This does not have an impact in VS Code.

tasks[n].openMode

Configure how the terminal should be opened relative to the previous task.

Note: split-top and split-bottom are deprecated values.

tasks[n].prebuild

Deprecated. Please use the init task instead.

mainConfiguration

mainConfiguration is currently in Beta. Send feedback.

Defines the repository with the main .gitpod.yml file and makes it possible to open the same workspace from any issue, branch or other context URL from any repository defined in a multi repository configuration.

Demo

Example

vscode

Configure the VS Code editor.

vscode.extensions

Define a list of extensions which should be installed for users of this workspace. The identifier of an extension is always ${publisher}.${name}. For example: ‘vscodevim.vim’.

Please note, Gitpod uses the Open VSX registry to find extensions. If you cannot find an extension you know exists in your local VS Code, please get in touch with us or open a new PR in the open-vsx/publish-extensions repository to add the extension to Open VSX 🙏.

By default, extensions will use the latest available version unless you use a specific version number. The version number must use semantic versioning rules. If you are interested in importing an extension that is not published on the Open VSX registry you can directly use the full URL.

Example

workspaceLocation

Define which path Gitpod considers the project’s workspace directory, relative to /workspace.

In most cases, this is not needed. If you work on an older Go project, please see Checkout and Workspace Location for more details.

Example