Package io.github.cdklabs.projen.github

Interface PullRequestFromPatchOptions

All Superinterfaces:

CreatePullRequestOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PullRequestFromPatchOptions.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PullRequestFromPatchOptions.Builder	builder()
default String	getJobName()	(experimental) The name of the job displayed on GitHub.
PullRequestPatchSource	getPatch()	(experimental) Information about the patch that is used to create the pull request.
default List<String>	getRunsOn()	(experimental) Github Runner selection labels.
default GroupRunnerOptions	getRunsOnGroup()	(experimental) Github Runner Group selection options.

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

getAssignees, getBaseBranch, getBranchName, getCredentials, getGitIdentity, getLabels, getPullRequestDescription, getPullRequestTitle, getSignoff, getStepId, getStepName, getWorkflowName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPatch

@Stability(Experimental)
@NotNull
PullRequestPatchSource getPatch()

(experimental) Information about the patch that is used to create the pull request.

getJobName

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

(experimental) The name of the job displayed on GitHub.

Default: "Create Pull Request"

getRunsOn

@Stability(Experimental)
@Nullable
default List<String> getRunsOn()

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

getRunsOnGroup

@Stability(Experimental)
@Nullable
default GroupRunnerOptions getRunsOnGroup()

(experimental) Github Runner Group selection options.

builder

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

Returns:

a PullRequestFromPatchOptions.Builder of PullRequestFromPatchOptions