Package io.github.cdklabs.projen

Interface GitpodPrebuilds

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitpodPrebuilds.Jsii$Proxy

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

(experimental) Configure the Gitpod App for prebuilds.

Currently only GitHub is supported.

See Also:

https://www.gitpod.io/docs/prebuilds/

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GitpodPrebuilds.Builder	builder()
default Boolean	getAddBadge()	(experimental) Add a "Review in Gitpod" button to the pull request's description.
default Boolean	getAddCheck()	(experimental) Add a check to pull requests.
default Boolean	getAddComment()	(experimental) Add a "Review in Gitpod" button as a comment to pull requests.
default Boolean	getAddLabel()	(experimental) Add a label once the prebuild is ready to pull requests.
default Boolean	getBranches()	(experimental) Enable for all branches in this repo.
default Boolean	getMaster()	(experimental) Enable for the master/default branch.
default Boolean	getPullRequests()	(experimental) Enable for pull requests coming from this repo.
default Boolean	getPullRequestsFromForks()	(experimental) Enable for pull requests coming from forks.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddBadge

@Stability(Experimental)
@Nullable
default Boolean getAddBadge()

(experimental) Add a "Review in Gitpod" button to the pull request's description.

Default: false

getAddCheck

@Stability(Experimental)
@Nullable
default Boolean getAddCheck()

(experimental) Add a check to pull requests.

Default: true

getAddComment

@Stability(Experimental)
@Nullable
default Boolean getAddComment()

(experimental) Add a "Review in Gitpod" button as a comment to pull requests.

Default: false

getAddLabel

@Stability(Experimental)
@Nullable
default Boolean getAddLabel()

(experimental) Add a label once the prebuild is ready to pull requests.

Default: false

getBranches

@Stability(Experimental)
@Nullable
default Boolean getBranches()

(experimental) Enable for all branches in this repo.

Default: false

getMaster

@Stability(Experimental)
@Nullable
default Boolean getMaster()

(experimental) Enable for the master/default branch.

Default: true

getPullRequests

@Stability(Experimental)
@Nullable
default Boolean getPullRequests()

(experimental) Enable for pull requests coming from this repo.

Default: true

getPullRequestsFromForks

@Stability(Experimental)
@Nullable
default Boolean getPullRequestsFromForks()

(experimental) Enable for pull requests coming from forks.

Default: false

builder

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

Returns:

a GitpodPrebuilds.Builder of GitpodPrebuilds