@groovy.transform.CompileStatic abstract class GenerateChangelog extends org.gradle.api.DefaultTask
This task generates a changelog for the project based on the Git history using Git Version.
| Fields inherited from class | Fields |
|---|---|
class org.gradle.api.DefaultTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS |
| Constructor and description |
|---|
GenerateChangelog
() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
exec() |
|
abstract org.gradle.api.provider.Property<java.lang.Boolean> |
getBuildMarkdown()Whether to build the changelog in markdown format. |
|
abstract org.gradle.api.file.DirectoryProperty |
getGitDirectory()The .git directory to base the Git Version off of. |
|
abstract org.gradle.api.file.ProjectLayout |
getLayout() |
|
abstract org.gradle.api.model.ObjectFactory |
getObjects() |
|
abstract org.gradle.api.file.RegularFileProperty |
getOutputFile()The output file for the changelog. |
|
abstract org.gradle.api.provider.Property<java.lang.String> |
getProjectPath()The path string of the project from the root. |
|
abstract org.gradle.api.provider.Property<java.lang.String> |
getProjectUrl()The project URL to use in the changelog. |
|
abstract org.gradle.api.provider.ProviderFactory |
getProviders() |
|
abstract org.gradle.api.provider.Property<java.lang.String> |
getStart()The tag (or object ID) to start the changelog from. |
| Methods inherited from class | Name |
|---|---|
class org.gradle.api.DefaultTask |
org.gradle.api.DefaultTask#setDescription(java.lang.String), org.gradle.api.DefaultTask#getAnt(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#setGroup(java.lang.String), org.gradle.api.DefaultTask#getProject(), org.gradle.api.DefaultTask#getDidWork(), org.gradle.api.DefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(groovy.lang.Closure), org.gradle.api.DefaultTask#doFirst(org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#getEnabled(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getDestroyables(), org.gradle.api.DefaultTask#getLocalState(), org.gradle.api.DefaultTask#getTemporaryDir(), org.gradle.api.DefaultTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getMustRunAfter(), org.gradle.api.DefaultTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.DefaultTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.DefaultTask#getFinalizedBy(), org.gradle.api.DefaultTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getShouldRunAfter(), org.gradle.api.DefaultTask#getTimeout(), org.gradle.api.DefaultTask#usesService(org.gradle.api.provider.Provider), org.gradle.api.DefaultTask#dependsOn([Ljava.lang.Object;), org.gradle.api.DefaultTask#setActions(java.util.List), org.gradle.api.DefaultTask#getDependsOn(), org.gradle.api.DefaultTask#setDependsOn(java.lang.Iterable), org.gradle.api.DefaultTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#onlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#onlyIf(java.lang.String, org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setOnlyIf(java.lang.String, org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setDidWork(boolean), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getName(), org.gradle.api.DefaultTask#compareTo(java.lang.Object), org.gradle.api.DefaultTask#compareTo(org.gradle.api.Task), org.gradle.api.DefaultTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.DefaultTask#getLogger(), org.gradle.api.DefaultTask#getActions(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getPath(), org.gradle.api.DefaultTask#getExtensions(), org.gradle.api.DefaultTask#property(java.lang.String), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#getDescription(), org.gradle.api.DefaultTask#setEnabled(boolean), org.gradle.api.DefaultTask#hasProperty(java.lang.String), org.gradle.api.DefaultTask#getGroup(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getAsDynamicObject(), org.gradle.api.DefaultTask#getConvention(), org.gradle.api.DefaultTask#notCompatibleWithConfigurationCache(java.lang.String), org.gradle.api.DefaultTask#doNotTrackState(java.lang.String), org.gradle.api.DefaultTask#getIdentityPath(), org.gradle.api.DefaultTask#isCompatibleWithConfigurationCache(), org.gradle.api.DefaultTask#getReasonTaskIsIncompatibleWithConfigurationCache(), org.gradle.api.DefaultTask#getStandardOutputCapture(), org.gradle.api.DefaultTask#getSharedResources(), org.gradle.api.DefaultTask#getLifecycleDependencies(), org.gradle.api.DefaultTask#getLifecycleDependencies(), org.gradle.api.DefaultTask#getTaskIdentity(), org.gradle.api.DefaultTask#acceptServiceReferences(java.util.Set), org.gradle.api.DefaultTask#getTaskActions(), org.gradle.api.DefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.gradle.api.DefaultTask#hasTaskActions(), org.gradle.api.DefaultTask#getOnlyIf(), org.gradle.api.DefaultTask#getReasonNotToTrackState(), org.gradle.api.DefaultTask#getImpliesSubProjects(), org.gradle.api.DefaultTask#setImpliesSubProjects(boolean), org.gradle.api.DefaultTask#getTemporaryDirFactory(), org.gradle.api.DefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#isHasCustomActions(), org.gradle.api.DefaultTask#getRequiredServices(), org.gradle.api.DefaultTask#isEnabled(), org.gradle.api.DefaultTask#wait(long, int), org.gradle.api.DefaultTask#wait(), org.gradle.api.DefaultTask#wait(long), org.gradle.api.DefaultTask#equals(java.lang.Object), org.gradle.api.DefaultTask#toString(), org.gradle.api.DefaultTask#hashCode(), org.gradle.api.DefaultTask#getClass(), org.gradle.api.DefaultTask#notify(), org.gradle.api.DefaultTask#notifyAll() |
Whether to build the changelog in markdown format.
The .git directory to base the Git Version off of.
The output file for the changelog.
The path string of the project from the root. Used to configure Git Version without needing to specify the directory itself.
The project URL to use in the changelog. Will attempt to use GitVersion.Info#getUrl() if unspecified.
The tag (or object ID) to start the changelog from.