Package io.github.cdklabs.projen

Interface GitpodOptions

All Superinterfaces:

DevEnvironmentOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitpodOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.756Z")
@Stability(Experimental)
public interface GitpodOptions
extends software.amazon.jsii.JsiiSerializable, DevEnvironmentOptions

(experimental) Constructor options for the Gitpod component.

By default, Gitpod uses the 'gitpod/workspace-full' docker image.

See Also:

https://github.com/gitpod-io/workspace-images/blob/master/full/Dockerfile By default, all tasks will be run in parallel. To run the tasks in sequence, create a new task and specify the other tasks as subtasks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GitpodOptions.Builder	A builder for GitpodOptions
static class	GitpodOptions.Jsii$Proxy	An implementation for GitpodOptions

Method Summary

Modifier and Type	Method	Description
static GitpodOptions.Builder	builder()
default GitpodPrebuilds	getPrebuilds()	(experimental) Optional Gitpod's Github App integration for prebuilds If this is not set and Gitpod's Github App is installed, then Gitpod will apply these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app.

Methods inherited from interface io.github.cdklabs.projen.DevEnvironmentOptions

getDockerImage, getPorts, getTasks, getVscodeExtensions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPrebuilds

@Stability(Experimental)
@Nullable
default GitpodPrebuilds getPrebuilds()

(experimental) Optional Gitpod's Github App integration for prebuilds If this is not set and Gitpod's Github App is installed, then Gitpod will apply these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app.

Default: undefined

builder

@Stability(Experimental)
static GitpodOptions.Builder builder()

Returns:

a GitpodOptions.Builder of GitpodOptions