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(value=Experimental)
public static final class PullRequestLintOptions.Builder
extends Object
implements software.amazon.jsii.Builder<PullRequestLintOptions>

A builder for PullRequestLintOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PullRequestLintOptions	build() Builds the configured instance.
PullRequestLintOptions.Builder	runsOn(List<String> runsOn) Sets the value of PullRequestLintOptions.getRunsOn()
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

runsOn

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

Sets the value of PullRequestLintOptions.getRunsOn()

Parameters:

runsOn - Github Runner selection labels.

Returns:

this

semanticTitle

@Stability(value=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(value=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(value=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