Package io.github.cdklabs.projen.github

Interface PullRequestLintOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PullRequestLintOptions.Jsii$Proxy

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

(experimental) Options for PullRequestLint.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PullRequestLintOptions.Builder	builder()
default String	getContributorStatement()	(experimental) Require a contributor statement to be included in the PR description.
default ContributorStatementOptions	getContributorStatementOptions()	(experimental) Options for requiring a contributor statement on Pull Requests.
default List<String>	getRunsOn()	(experimental) Github Runner selection labels.
default GroupRunnerOptions	getRunsOnGroup()	(experimental) Github Runner Group selection options.
default Boolean	getSemanticTitle()	(experimental) Validate that pull request titles follow Conventional Commits.
default SemanticTitleOptions	getSemanticTitleOptions()	(experimental) Options for validating the conventional commit title linter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContributorStatement

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

(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

getContributorStatementOptions

@Stability(Experimental)
@Nullable
default ContributorStatementOptions getContributorStatementOptions()

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

Default: - none

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.

getSemanticTitle

@Stability(Experimental)
@Nullable
default Boolean getSemanticTitle()

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

Default: true

See Also:

https://www.conventionalcommits.org/

getSemanticTitleOptions

@Stability(Experimental)
@Nullable
default SemanticTitleOptions getSemanticTitleOptions()

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

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

builder

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

Returns:

a PullRequestLintOptions.Builder of PullRequestLintOptions