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 DefaultTaskThis is an helper task to show the create the changelog.
-
-
Field Summary
Fields Modifier and Type Field Description private StringprojectVersionprivate StringpreVersionprivate final RevObjectendRevObjectprivate FilechangelogFileprivate final TaskOutputsInternaloutputsprivate final Spec<in TaskInternal>onlyIfprivate final Property<Duration>timeoutprivate final TaskRequiredServicesrequiredServicesprivate final TaskDependencyInternaltaskDependenciesprivate final Set<Object>dependsOnprivate final TaskDestroyablesdestroyablesprivate final Loggerloggerprivate final Stringpathprivate final Factory<File>temporaryDirFactoryprivate final Optional<String>reasonTaskIsIncompatibleWithConfigurationCacheprivate final TaskLocalStatelocalStateprivate final List<InputChangesAwareTaskAction>taskActionsprivate final TaskDependencyInternallifecycleDependenciesprivate BooleanisEnabledprivate BooleanimpliesSubProjectsprivate final TaskInputsInternalinputsprivate Booleanenabledprivate final TaskStateInternalstateprivate final TaskIdentity<?>taskIdentityprivate final TaskDependencyshouldRunAfterprivate final ExtensionContainerextensionsprivate final BooleanisCompatibleWithConfigurationCacheprivate final TaskDependencyfinalizedByprivate final AntBuilderantprivate final DynamicObjectasDynamicObjectprivate final List<ResourceLock>sharedResourcesprivate BooleandidWorkprivate final Optional<String>reasonNotToTrackStateprivate Stringgroupprivate final Set<String>reasonsNotToTrackStateprivate final BooleanisHasCustomActionsprivate List<Action<in Task>>actionsprivate final Stringnameprivate final FiletemporaryDirprivate final LoggingManagerloggingprivate final PathidentityPathprivate final TaskDependencymustRunAfterprivate final StandardOutputCapturestandardOutputCaptureprivate final Projectprojectprivate Stringdescription
-
Constructor Summary
Constructors Constructor Description CreateChangeLog(ObjectFactory objectFactory, ProjectLayout projectLayout)
-
Method Summary
Modifier and Type Method Description final StringgetProjectVersion()The version of the project this task belongs to. final UnitsetProjectVersion(String value)The version of the project this task belongs to. final StringgetPreVersion()This is the property with command line option to specify the start version of the change log calculation. final UnitsetPreVersion(String value)This is the property with command line option to specify the start version of the change log calculation. final RevObjectgetEndRevObject()This method calculates the end version of the report. final FilegetChangelogFile()Input file property for output. final UnitsetChangelogFile(File value)Input file property for output. final UnitprovidePrevVersion(Provider<String> prevVersion)This is the provider for the targetVersion. final UnitprovideProjectVersion(Provider<String> projectVersion)This is the provider for the version of the project this task belongs to. final UnitprovideChangelogFile(Provider<RegularFile> changelogFile)Provider for output file property. final Unitrun()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
-
-
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.
-
getChangelogFile
@OutputFile() final File getChangelogFile()
Input file property for output.
-
setChangelogFile
final Unit setChangelogFile(File value)
Input file property for output.
-
providePrevVersion
final Unit providePrevVersion(Provider<String> prevVersion)
This is the provider for the targetVersion.
-
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.
-
-
-
-