io.github.cdklabs.projen.github

Class PullRequestLint.Builder

java.lang.Object

io.github.cdklabs.projen.github.PullRequestLint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PullRequestLint>

Enclosing class:

PullRequestLint

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

(experimental) A fluent builder for PullRequestLint.

Method Summary

Modifier and Type	Method and Description
PullRequestLint	build()
static PullRequestLint.Builder	create(GitHub github)
PullRequestLint.Builder	runsOn(List<String> runsOn) (experimental) Github Runner selection labels.
PullRequestLint.Builder	semanticTitle(Boolean semanticTitle) (experimental) Validate that pull request titles follow Conventional Commits.
PullRequestLint.Builder	semanticTitleOptions(SemanticTitleOptions semanticTitleOptions) (experimental) Options for validating the conventional commit title linter.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static PullRequestLint.Builder create(GitHub github)

Parameters:

github - This parameter is required.

Returns:

a new instance of PullRequestLint.Builder.

runsOn

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

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Parameters:

runsOn - Github Runner selection labels. This parameter is required.

Returns:

this

semanticTitle

@Stability(value=Experimental)
public PullRequestLint.Builder semanticTitle(Boolean semanticTitle)

(experimental) Validate that pull request titles follow Conventional Commits.

Default: true

Parameters:

semanticTitle - Validate that pull request titles follow Conventional Commits. This parameter is required.

Returns:

this

See Also:

https://www.conventionalcommits.org/

semanticTitleOptions

@Stability(value=Experimental)
public PullRequestLint.Builder semanticTitleOptions(SemanticTitleOptions semanticTitleOptions)

(experimental) Options for validating the conventional commit title linter.

Default: - title must start with "feat", "fix", or "chore"

Parameters:

semanticTitleOptions - Options for validating the conventional commit title linter. This parameter is required.

Returns:

this

build

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

Specified by:

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