Interface GenerateChangelog

All Superinterfaces:

Comparable<Task>, ExtensionAware, Named, Task

public sealed interface GenerateChangelog
extends Task

Generates a changelog for the project based on the Git history using Git Version.

Nested Class Summary

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

Named.Namer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name for the task, used by the extension when registering it.

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

Method Summary

Modifier and Type	Method	Description
Property<Boolean>	getBuildMarkdown()	Whether to build the changelog in Markdown format.
RegularFileProperty	getOutputFile()	The output file for the changelog.
Property<String>	getProjectUrl()	The project URL to use in the changelog.
Property<String>	getStart()	The tag (or object ID) to start the changelog from.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.gradle.api.plugins.ExtensionAware

getExtensions

Methods inherited from interface org.gradle.api.Task

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

Field Details

NAME

static final String NAME

The name for the task, used by the extension when registering it.

See Also:

• Constant Field Values

Method Details

getOutputFile

@OutputFile
RegularFileProperty getOutputFile()

The output file for the changelog.

Returns:

A property for the output file

getStart

@Input
@Optional
Property<String> getStart()

The tag (or object ID) to start the changelog from.

Returns:

A property for the start tag

getProjectUrl

@Input
@Optional
Property<String> getProjectUrl()

The project URL to use in the changelog.

Git Version will automatically attempt to find a URL from the repository's remote details if left unspecified.

Returns:

A property for the project URL

getBuildMarkdown

@Input
Property<Boolean> getBuildMarkdown()

Whether to build the changelog in Markdown format.

Returns:

A property for Markdown formatting