Package io.github.cdklabs.projen.github
Class PullRequestLintOptions.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- io.github.cdklabs.projen.github.PullRequestLintOptions.Jsii$Proxy
-
- All Implemented Interfaces:
PullRequestLintOptions,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- PullRequestLintOptions
@Stability(Experimental) @Internal public static final class PullRequestLintOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements PullRequestLintOptions
An implementation forPullRequestLintOptions
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Nested classes/interfaces inherited from interface io.github.cdklabs.projen.github.PullRequestLintOptions
PullRequestLintOptions.Builder, PullRequestLintOptions.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(PullRequestLintOptions.Builder builder)Constructor that initializes the object based on literal property values passed by thePullRequestLintOptions.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)StringgetContributorStatement()(experimental) Require a contributor statement to be included in the PR description.ContributorStatementOptionsgetContributorStatementOptions()(experimental) Options for requiring a contributor statement on Pull Requests.List<String>getRunsOn()(experimental) Github Runner selection labels.GroupRunnerOptionsgetRunsOnGroup()(experimental) Github Runner Group selection options.BooleangetSemanticTitle()(experimental) Validate that pull request titles follow Conventional Commits.SemanticTitleOptionsgetSemanticTitleOptions()(experimental) Options for validating the conventional commit title linter.inthashCode()
-
-
-
Constructor Detail
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
protected Jsii$Proxy(PullRequestLintOptions.Builder builder)
Constructor that initializes the object based on literal property values passed by thePullRequestLintOptions.Builder.
-
-
Method Detail
-
getContributorStatement
public final String getContributorStatement()
Description copied from interface:PullRequestLintOptions(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
- Specified by:
getContributorStatementin interfacePullRequestLintOptions
-
getContributorStatementOptions
public final ContributorStatementOptions getContributorStatementOptions()
Description copied from interface:PullRequestLintOptions(experimental) Options for requiring a contributor statement on Pull Requests.Default: - none
- Specified by:
getContributorStatementOptionsin interfacePullRequestLintOptions
-
getRunsOn
public final List<String> getRunsOn()
Description copied from interface:PullRequestLintOptions(experimental) Github Runner selection labels.Default: ["ubuntu-latest"]
- Specified by:
getRunsOnin interfacePullRequestLintOptions
-
getRunsOnGroup
public final GroupRunnerOptions getRunsOnGroup()
Description copied from interface:PullRequestLintOptions(experimental) Github Runner Group selection options.- Specified by:
getRunsOnGroupin interfacePullRequestLintOptions
-
getSemanticTitle
public final Boolean getSemanticTitle()
Description copied from interface:PullRequestLintOptions(experimental) Validate that pull request titles follow Conventional Commits.Default: true
- Specified by:
getSemanticTitlein interfacePullRequestLintOptions- See Also:
- https://www.conventionalcommits.org/
-
getSemanticTitleOptions
public final SemanticTitleOptions getSemanticTitleOptions()
Description copied from interface:PullRequestLintOptions(experimental) Options for validating the conventional commit title linter.Default: - title must start with "feat", "fix", or "chore"
- Specified by:
getSemanticTitleOptionsin interfacePullRequestLintOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-