Package 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(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	Description
PullRequestLint	build()
PullRequestLint.Builder	contributorStatement(String contributorStatement)	(experimental) Require a contributor statement to be included in the PR description.
PullRequestLint.Builder	contributorStatementOptions(ContributorStatementOptions contributorStatementOptions)	(experimental) Options for requiring a contributor statement on Pull Requests.
static PullRequestLint.Builder	create(GitHub github)
PullRequestLint.Builder	runsOn(List<String> runsOn)	(experimental) Github Runner selection labels.
PullRequestLint.Builder	runsOnGroup(GroupRunnerOptions runsOnGroup)	(experimental) Github Runner Group selection options.
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(Experimental)
public static PullRequestLint.Builder create(GitHub github)

Parameters:

github - This parameter is required.

Returns:

a new instance of PullRequestLint.Builder.

contributorStatement

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

(experimental) 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.

Default: - no contributor statement is required

Parameters:

contributorStatement - Require a contributor statement to be included in the PR description. This parameter is required.

Returns:

this

contributorStatementOptions

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

(experimental) Options for requiring a contributor statement on Pull Requests.

Default: - none

Parameters:

contributorStatementOptions - Options for requiring a contributor statement on Pull Requests. This parameter is required.

Returns:

this

runsOn

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

runsOnGroup

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

(experimental) Github Runner Group selection options.

Parameters:

runsOnGroup - Github Runner Group selection options. This parameter is required.

Returns:

this

semanticTitle

@Stability(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(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(Experimental)
public PullRequestLint build()

Specified by:

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

Returns:

a newly built instance of PullRequestLint.