Package io.github.cdklabs.projen

Interface GitpodTask

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitpodTask.Jsii$Proxy

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

(experimental) Configure options for a task to be run when opening a Gitpod workspace (e.g. running tests, or starting a dev server).

Start Mode | Execution Fresh Workspace | before && init && command Restart Workspace | before && command Snapshot | before && command Prebuild | before && init && prebuild

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GitpodTask.Builder	builder()
default String	getBefore()	(experimental) In case you need to run something even before init, that is a requirement for both init and command, you can use the before property.
String	getCommand()	(experimental) Required.
default String	getInit()	(experimental) The init property can be used to specify shell commands that should only be executed after a workspace was freshly cloned and needs to be initialized somehow.
default String	getName()	(experimental) A name for this task.
default GitpodOpenIn	getOpenIn()	(experimental) You can configure where in the IDE the terminal should be opened.
default GitpodOpenMode	getOpenMode()	(experimental) You can configure how the terminal should be opened relative to the previous task.
default String	getPrebuild()	(experimental) The optional prebuild command will be executed during prebuilds.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCommand

@Stability(Experimental)
@NotNull
String getCommand()

(experimental) Required.

The shell command to run

getBefore

@Stability(Experimental)
@Nullable
default String getBefore()

(experimental) In case you need to run something even before init, that is a requirement for both init and command, you can use the before property.

getInit

@Stability(Experimental)
@Nullable
default String getInit()

(experimental) The init property can be used to specify shell commands that should only be executed after a workspace was freshly cloned and needs to be initialized somehow.

Such tasks are usually builds or downloading dependencies. Anything you only want to do once but not when you restart a workspace or start a snapshot.

getName

@Stability(Experimental)
@Nullable
default String getName()

(experimental) A name for this task.

Default: - task names are omitted when blank

getOpenIn

@Stability(Experimental)
@Nullable
default GitpodOpenIn getOpenIn()

(experimental) You can configure where in the IDE the terminal should be opened.

Default: GitpodOpenIn.BOTTOM

getOpenMode

@Stability(Experimental)
@Nullable
default GitpodOpenMode getOpenMode()

(experimental) You can configure how the terminal should be opened relative to the previous task.

Default: GitpodOpenMode.TAB_AFTER

getPrebuild

@Stability(Experimental)
@Nullable
default String getPrebuild()

(experimental) The optional prebuild command will be executed during prebuilds.

It is meant to run additional long running processes that could be useful, e.g. running test suites.

builder

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

Returns:

a GitpodTask.Builder of GitpodTask