Package io.github.cdklabs.projen.github

Interface CreatePullRequestOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

PullRequestFromPatchOptions

All Known Implementing Classes:

CreatePullRequestOptions.Jsii$Proxy, PullRequestFromPatchOptions.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CreatePullRequestOptions.Builder	builder()
default List<String>	getAssignees()	(experimental) Assignees to add on the PR.
default String	getBaseBranch()	(experimental) Sets the pull request base branch.
default String	getBranchName()	(experimental) The pull request branch name.
default GithubCredentials	getCredentials()	(experimental) The job credentials used to create the pull request.
default GitIdentity	getGitIdentity()	(experimental) The git identity used to create the commit.
default List<String>	getLabels()	(experimental) Labels to apply on the PR.
String	getPullRequestDescription()	(experimental) Description added to the pull request.
String	getPullRequestTitle()	(experimental) The full title used to create the pull request.
default Boolean	getSignoff()	(experimental) Add Signed-off-by line by the committer at the end of the commit log message.
default String	getStepId()	(experimental) The step ID which produces the output which indicates if a patch was created.
default String	getStepName()	(experimental) The name of the step displayed on GitHub.
String	getWorkflowName()	(experimental) The name of the workflow that will create the PR.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPullRequestDescription

@Stability(Experimental)
@NotNull
String getPullRequestDescription()

(experimental) Description added to the pull request.

Providence information are automatically added.

getPullRequestTitle

@Stability(Experimental)
@NotNull
String getPullRequestTitle()

(experimental) The full title used to create the pull request.

If PR titles are validated in this repo, the title should comply with the respective rules.

getWorkflowName

@Stability(Experimental)
@NotNull
String getWorkflowName()

(experimental) The name of the workflow that will create the PR.

getAssignees

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

(experimental) Assignees to add on the PR.

Default: - no assignees

getBaseBranch

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

(experimental) Sets the pull request base branch.

Default: - The branch checked out in the workflow.

getBranchName

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

(experimental) The pull request branch name.

Default: `github-actions/${options.workflowName}`

getCredentials

@Stability(Experimental)
@Nullable
default GithubCredentials getCredentials()

(experimental) The job credentials used to create the pull request.

Provided credentials must have permissions to create a pull request on the repository.

getGitIdentity

@Stability(Experimental)
@Nullable
default GitIdentity getGitIdentity()

(experimental) The git identity used to create the commit.

Default: - the default github-actions user

getLabels

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

(experimental) Labels to apply on the PR.

Default: - no labels.

getSignoff

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

(experimental) Add Signed-off-by line by the committer at the end of the commit log message.

Default: true

getStepId

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

(experimental) The step ID which produces the output which indicates if a patch was created.

Default: "create_pr"

getStepName

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

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

Default: "Create Pull Request"

builder

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

Returns:

a CreatePullRequestOptions.Builder of CreatePullRequestOptions