Class CommitlintCheckTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.tiltedwindmills.commitlint.gradle.CommitlintCheckTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault(because="Commit message changes on every commit") public abstract class CommitlintCheckTask extends org.gradle.api.DefaultTask
Task that lints a commit message file against Conventional Commits rules.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommitlintCheckTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    check()
     
    abstract org.gradle.api.file.RegularFileProperty
    getCommitMessageFile()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getDefaultIgnores()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getFailOnWarning()
     
    abstract org.gradle.api.provider.MapProperty<String, Map<String,String>>
    getRuleOverrides()
     

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • CommitlintCheckTask

      public CommitlintCheckTask()

  • Method Details

    • getCommitMessageFile

      @InputFile @PathSensitive(NONE) public abstract org.gradle.api.file.RegularFileProperty getCommitMessageFile()

    • getFailOnWarning

      @Input public abstract org.gradle.api.provider.Property<Boolean> getFailOnWarning()

    • getDefaultIgnores

      @Input public abstract org.gradle.api.provider.Property<Boolean> getDefaultIgnores()

    • getRuleOverrides

      @Input public abstract org.gradle.api.provider.MapProperty<String, Map<String,String>> getRuleOverrides()

    • check

      public void check()