io.github.cdklabs.projen.github

Interface SemanticTitleOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SemanticTitleOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.770Z")
 @Stability(value=Experimental)
public interface SemanticTitleOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for linting that PR titles follow Conventional Commits.

See Also:

https://www.conventionalcommits.org/

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SemanticTitleOptions.Builder	builder()
default Boolean	getRequireScope() (experimental) Configure that a scope must always be provided.
default List<String>	getTypes() (experimental) Configure a list of commit types that are allowed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRequireScope

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

(experimental) Configure that a scope must always be provided.

e.g. feat(ui), fix(core)

Default: false

getTypes

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

(experimental) Configure a list of commit types that are allowed.

Default: ["feat", "fix", "chore"]

builder

@Stability(value=Experimental)
static SemanticTitleOptions.Builder builder()

Returns:

a SemanticTitleOptions.Builder of SemanticTitleOptions