io.github.cdklabs.projen.github

Class AutoApproveOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.AutoApproveOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AutoApproveOptions>

Enclosing interface:

AutoApproveOptions

@Stability(value=Experimental)
public static final class AutoApproveOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AutoApproveOptions>

A builder for AutoApproveOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AutoApproveOptions.Builder	allowedUsernames(List<String> allowedUsernames) Sets the value of AutoApproveOptions.getAllowedUsernames()
AutoApproveOptions	build() Builds the configured instance.
AutoApproveOptions.Builder	label(String label) Sets the value of AutoApproveOptions.getLabel()
AutoApproveOptions.Builder	runsOn(List<String> runsOn) Sets the value of AutoApproveOptions.getRunsOn()
AutoApproveOptions.Builder	secret(String secret) Sets the value of AutoApproveOptions.getSecret()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

secret

@Stability(value=Experimental)
public AutoApproveOptions.Builder secret(String secret)

Sets the value of AutoApproveOptions.getSecret()

Parameters:

secret - A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope. This parameter is required. This token is used to approve pull requests.

Github forbids an identity to approve its own pull request. If your project produces automated pull requests using the Github default token - {@link https://docs.github.com/en/actions/reference/authentication-in-a-workflow GITHUB_TOKEN }

• that you would like auto approved, such as when using the depsUpgrade property in NodeProjectOptions, then you must use a different token here.

Returns:

this

allowedUsernames

@Stability(value=Experimental)
public AutoApproveOptions.Builder allowedUsernames(List<String> allowedUsernames)

Sets the value of AutoApproveOptions.getAllowedUsernames()

Parameters:

allowedUsernames - Only pull requests authored by these Github usernames will be auto-approved.

Returns:

this

label

@Stability(value=Experimental)
public AutoApproveOptions.Builder label(String label)

Sets the value of AutoApproveOptions.getLabel()

Parameters:

label - Only pull requests with this label will be auto-approved.

Returns:

this

runsOn

@Stability(value=Experimental)
public AutoApproveOptions.Builder runsOn(List<String> runsOn)

Sets the value of AutoApproveOptions.getRunsOn()

Parameters:

runsOn - Github Runner selection labels.

Returns:

this

build

@Stability(value=Experimental)
public AutoApproveOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AutoApproveOptions>

Returns:

a new instance of AutoApproveOptions

Throws:

NullPointerException - if any required attribute was not provided