Package io.github.cdklabs.projen.github

Class PullRequestLintOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.PullRequestLintOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PullRequestLintOptions>

Enclosing interface:

PullRequestLintOptions

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

A builder for PullRequestLintOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PullRequestLintOptions	build()	Builds the configured instance.
PullRequestLintOptions.Builder	contributorStatement(String contributorStatement)	Sets the value of PullRequestLintOptions.getContributorStatement()
PullRequestLintOptions.Builder	contributorStatementOptions(ContributorStatementOptions contributorStatementOptions)	Sets the value of PullRequestLintOptions.getContributorStatementOptions()
PullRequestLintOptions.Builder	runsOn(List<String> runsOn)	Sets the value of PullRequestLintOptions.getRunsOn()
PullRequestLintOptions.Builder	runsOnGroup(GroupRunnerOptions runsOnGroup)	Sets the value of PullRequestLintOptions.getRunsOnGroup()
PullRequestLintOptions.Builder	semanticTitle(Boolean semanticTitle)	Sets the value of PullRequestLintOptions.getSemanticTitle()
PullRequestLintOptions.Builder	semanticTitleOptions(SemanticTitleOptions semanticTitleOptions)	Sets the value of PullRequestLintOptions.getSemanticTitleOptions()

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

contributorStatement

@Stability(Experimental)
public PullRequestLintOptions.Builder contributorStatement(String contributorStatement)

Sets the value of PullRequestLintOptions.getContributorStatement()

Parameters:

contributorStatement - Require a contributor statement to be included in the PR description. For example confirming that the contribution has been made by the contributor and complies with the project's license.

Appends the statement to the end of the Pull Request template.

Returns:

this

contributorStatementOptions

@Stability(Experimental)
public PullRequestLintOptions.Builder contributorStatementOptions(ContributorStatementOptions contributorStatementOptions)

Sets the value of PullRequestLintOptions.getContributorStatementOptions()

Parameters:

contributorStatementOptions - Options for requiring a contributor statement on Pull Requests.

Returns:

this

runsOn

@Stability(Experimental)
public PullRequestLintOptions.Builder runsOn(List<String> runsOn)

Sets the value of PullRequestLintOptions.getRunsOn()

Parameters:

runsOn - Github Runner selection labels.

Returns:

this

runsOnGroup

@Stability(Experimental)
public PullRequestLintOptions.Builder runsOnGroup(GroupRunnerOptions runsOnGroup)

Sets the value of PullRequestLintOptions.getRunsOnGroup()

Parameters:

runsOnGroup - Github Runner Group selection options.

Returns:

this

semanticTitle

@Stability(Experimental)
public PullRequestLintOptions.Builder semanticTitle(Boolean semanticTitle)

Sets the value of PullRequestLintOptions.getSemanticTitle()

Parameters:

semanticTitle - Validate that pull request titles follow Conventional Commits.

Returns:

this

semanticTitleOptions

@Stability(Experimental)
public PullRequestLintOptions.Builder semanticTitleOptions(SemanticTitleOptions semanticTitleOptions)

Sets the value of PullRequestLintOptions.getSemanticTitleOptions()

Parameters:

semanticTitleOptions - Options for validating the conventional commit title linter.

Returns:

this

build

@Stability(Experimental)
public PullRequestLintOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PullRequestLintOptions

Throws:

NullPointerException - if any required attribute was not provided