org.shipkit.changelog

Class GenerateChangelogTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.shipkit.changelog.GenerateChangelogTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class GenerateChangelogTask
extends org.gradle.api.DefaultTask

Generates changelog based on the Github ticked ids found in commit messages.

Nested Class Summary

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

org.gradle.api.Task.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 and Description
GenerateChangelogTask()

Method Summary

Modifier and Type	Method and Description
void	generateChangelog()
java.lang.String	getDate() The release date
java.lang.String	getGithubApiUrl()
java.lang.String	getGithubToken() See setGithubToken(String)
java.lang.String	getGithubUrl()
java.io.File	getOutputFile()
java.lang.String	getPreviousRevision() Previous revision for changelog generation.
java.lang.String	getReadOnlyToken() Deprecated.
java.lang.String	getRepository()
java.lang.String	getRevision() Target revision for changelog generation.
java.lang.String	getVersion()
java.io.File	getWorkingDir()
void	setDate(java.lang.String date)
void	setGithubApiUrl(java.lang.String githubApiUrl)
void	setGithubToken(java.lang.String githubToken) Github token used to pull Github issues.
void	setGithubUrl(java.lang.String githubUrl)
void	setOutputFile(java.io.File outputFile)
void	setPreviousRevision(java.lang.String previousRevision) See getPreviousRevision()
void	setReadOnlyToken(java.lang.String readOnlyToken) Deprecated.
void	setRepository(java.lang.String repository)
void	setRevision(java.lang.String revision) See getRevision()
void	setVersion(java.lang.String version)
void	setWorkingDir(java.io.File workingDir)

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, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, replaceLogger, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

getConvention

Constructor Detail

GenerateChangelogTask

public GenerateChangelogTask()

Method Detail

getDate

@Input
public java.lang.String getDate()

The release date

setDate

public void setDate(java.lang.String date)

getGithubUrl

@Input
public java.lang.String getGithubUrl()

setGithubUrl

public void setGithubUrl(java.lang.String githubUrl)

getPreviousRevision

@Input
 @Optional
public java.lang.String getPreviousRevision()

Previous revision for changelog generation. The changelog is generated between #getPreviousRevision() and getRevision(). This property is marked as Optional because the null value is permitted. In this case the task will use "HEAD" as previous revision. This way, the task behaves gracefully when generating changelog for the first time (very first version).

setPreviousRevision

public void setPreviousRevision(java.lang.String previousRevision)

See getPreviousRevision()

getVersion

@Input
public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getRevision

@Input
public java.lang.String getRevision()

Target revision for changelog generation. The changelog is generated between getPreviousRevision() and #getRevision().

setRevision

public void setRevision(java.lang.String revision)

See getRevision()

getRepository

@Input
public java.lang.String getRepository()

setRepository

public void setRepository(java.lang.String repository)

getGithubApiUrl

@Input
public java.lang.String getGithubApiUrl()

setGithubApiUrl

public void setGithubApiUrl(java.lang.String githubApiUrl)

getOutputFile

@OutputFile
public java.io.File getOutputFile()

setOutputFile

public void setOutputFile(java.io.File outputFile)

getWorkingDir

@InputDirectory
public java.io.File getWorkingDir()

setWorkingDir

public void setWorkingDir(java.io.File workingDir)

getReadOnlyToken

@Input
 @Optional
 @Deprecated
public java.lang.String getReadOnlyToken()

Deprecated.

Deprecated, please use getGithubToken()

setReadOnlyToken

@Deprecated
public void setReadOnlyToken(java.lang.String readOnlyToken)

Deprecated.

Deprecated, please use setGithubToken(String)

getGithubToken

@Input
public java.lang.String getGithubToken()

See setGithubToken(String)

setGithubToken

public void setGithubToken(java.lang.String githubToken)

Github token used to pull Github issues. The same token is used to post a new release: GithubReleaseTask.setGithubToken(String)

generateChangelog

public void generateChangelog()