Class CreateChangeLog

  • All Implemented Interfaces:
    kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable

    @DisableCachingByDefault(because = "The changelog depends on the Git history, which is not tracked as a task input.") 
    public abstract class CreateChangeLog
    extends DefaultTask
                        

    This is an helper task to show the create the changelog.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
      CreateChangeLog(ObjectFactory objectFactory, ProjectLayout projectLayout)
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final String getProjectVersion() The version of the project this task belongs to.
      final Unit setProjectVersion(String value) The version of the project this task belongs to.
      final String getPreVersion() This is the property with command line option to specify the start version of the change log calculation.
      final Unit setPreVersion(String value) This is the property with command line option to specify the start version of the change log calculation.
      final RevObject getEndRevObject() This method calculates the end version of the report.
      final File getChangelogFile() Input file property for output.
      final Unit setChangelogFile(File value) Input file property for output.
      final Unit providePrevVersion(Provider<String> prevVersion) This is the provider for the targetVersion.
      final Unit provideProjectVersion(Provider<String> projectVersion) This is the provider for the version of the project this task belongs to.
      final Unit provideChangelogFile(Provider<RegularFile> changelogFile) Provider for output file property.
      final Unit run() Main function of this task.
      • Methods inherited from class org.gradle.api.DefaultTask

        getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup
      • Methods inherited from class org.gradle.api.internal.AbstractTask

        getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects
      • Methods inherited from class org.gradle.api.Task

        configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
      • Methods inherited from class kotlin.Comparable

        compareTo
      • Methods inherited from class org.gradle.api.internal.TaskInternal

        acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CreateChangeLog

        CreateChangeLog(ObjectFactory objectFactory, ProjectLayout projectLayout)
    • Method Detail

      • getProjectVersion

        @Input() final String getProjectVersion()

        The version of the project this task belongs to. It is written to the header of the changelog.

      • setProjectVersion

         final Unit setProjectVersion(String value)

        The version of the project this task belongs to. It is written to the header of the changelog.

      • getPreVersion

        @Optional()@Input() final String getPreVersion()

        This is the property with command line option to specify the start version of the change log calculation.

      • setPreVersion

         final Unit setPreVersion(String value)

        This is the property with command line option to specify the start version of the change log calculation.

      • getEndRevObject

        @Input() final RevObject getEndRevObject()

        This method calculates the end version of the report. It returns an JGit object.

      • provideProjectVersion

         final Unit provideProjectVersion(Provider<String> projectVersion)

        This is the provider for the version of the project this task belongs to. It is provided by the plugin at configuration time, so that the task does not access the project during execution.

      • provideChangelogFile

         final Unit provideChangelogFile(Provider<RegularFile> changelogFile)

        Provider for output file property.

      • run

         final Unit run()

        Main function of this task.