Package 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.96.0 (build 921e240)", date="2024-03-28T21:16:43.088Z") @Stability(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 Description static classSemanticTitleOptions.BuilderA builder forSemanticTitleOptionsstatic classSemanticTitleOptions.Jsii$ProxyAn implementation forSemanticTitleOptions
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SemanticTitleOptions.Builderbuilder()default BooleangetRequireScope()(experimental) Configure that a scope must always be provided.default List<String>getTypes()(experimental) Configure a list of commit types that are allowed.
-
-
-
Method Detail
-
getRequireScope
@Stability(Experimental) @Nullable default Boolean getRequireScope()
(experimental) Configure that a scope must always be provided.e.g. feat(ui), fix(core)
Default: false
-
getTypes
@Stability(Experimental) @Nullable default List<String> getTypes()
(experimental) Configure a list of commit types that are allowed.Default: ["feat", "fix", "chore"]
-
builder
@Stability(Experimental) static SemanticTitleOptions.Builder builder()
- Returns:
- a
SemanticTitleOptions.BuilderofSemanticTitleOptions
-
-