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.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.769Z")
 @Stability(value=Experimental)
public interface PullRequestLintOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for PullRequestLint.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static PullRequestLintOptions.Builder	builder()
default List<String>	getRunsOn() (experimental) Github Runner selection labels.
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

getRunsOn

@Stability(value=Experimental)
 @Nullable
default List<String> getRunsOn()

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

getSemanticTitle

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

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

Default: true

See Also:

https://www.conventionalcommits.org/

getSemanticTitleOptions

@Stability(value=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(value=Experimental)
static PullRequestLintOptions.Builder builder()

Returns:

a PullRequestLintOptions.Builder of PullRequestLintOptions