Package io.github.cdklabs.projen.github

Interface AutoApproveOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoApproveOptions.Jsii$Proxy

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

(experimental) Options for 'AutoApprove'.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AutoApproveOptions.Builder	builder()
default List<String>	getAllowedUsernames()	(experimental) Only pull requests authored by these Github usernames will be auto-approved.
default String	getLabel()	(experimental) Only pull requests with this label will be auto-approved.
default List<String>	getRunsOn()	(experimental) Github Runner selection labels.
default GroupRunnerOptions	getRunsOnGroup()	(experimental) Github Runner Group selection options.
default String	getSecret()	(experimental) A GitHub secret name which contains a GitHub Access Token with write permissions for the pull_request scope.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllowedUsernames

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

(experimental) Only pull requests authored by these Github usernames will be auto-approved.

Default: ['github-bot']

getLabel

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

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

Default: 'auto-approve'

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.

getSecret

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

(experimental) A GitHub secret name which contains a GitHub Access Token with write permissions for the pull_request scope.

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.

Default: "GITHUB_TOKEN"

builder

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

Returns:

a AutoApproveOptions.Builder of AutoApproveOptions