org.mockito.release.internal.gradle

Class DefaultReleaseNotesExtension

java.lang.Object

org.mockito.release.internal.gradle.DefaultReleaseNotesExtension

All Implemented Interfaces:

ReleaseNotesExtension

public class DefaultReleaseNotesExtension
extends java.lang.Object
implements ReleaseNotesExtension

Constructor Summary

Constructors

Constructor and Description
DefaultReleaseNotesExtension(java.io.File workDir, java.lang.String extensionName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCompleteReleaseNotes()
java.util.Map<java.lang.String,java.lang.String>	getGitHubLabelMapping() The mapping of "GitHub label" to human readable and presentable name.
java.lang.String	getGitHubReadOnlyAuthToken() GitHub read only auth token for getting the issue links.
java.lang.String	getGitHubRepository() GitHub repository, for example: "mockito/mockito"
java.lang.String	getPreviousVersion() Returns previous version based on the release notes file.
java.lang.String	getReleaseNotes(java.lang.String version) Generates and returns incremental release notes text that can be appended to the release notes file.
java.io.File	getReleaseNotesFile() The file where the release notes are kept.
void	setGitHubLabelMapping(java.util.Map<java.lang.String,java.lang.String> gitHubLabelMapping) See ReleaseNotesExtension.getGitHubLabelMapping().
void	setGitHubReadOnlyAuthToken(java.lang.String gitHubAuthToken) GitHub read only auth token for getting the issue links.
void	setGitHubRepository(java.lang.String gitHubRepository) GitHub repository, for example: "mockito/mockito"
void	setReleaseNotesFile(java.io.File file) The file where the release notes are kept.
void	updateReleaseNotes(java.lang.String version) Generates incremental release notes content using ReleaseNotesExtension.getReleaseNotes(String) )} and appends it to the top of release notes file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultReleaseNotesExtension

public DefaultReleaseNotesExtension(java.io.File workDir,
                                    java.lang.String extensionName)

Method Detail

getPreviousVersion

public java.lang.String getPreviousVersion()

Description copied from interface: ReleaseNotesExtension

Returns previous version based on the release notes file. It parses the first line of the release notes file to identify previously released version.

Specified by:

getPreviousVersion in interface ReleaseNotesExtension

getReleaseNotes

public java.lang.String getReleaseNotes(java.lang.String version)

Description copied from interface: ReleaseNotesExtension

Generates and returns incremental release notes text that can be appended to the release notes file.

Specified by:

getReleaseNotes in interface ReleaseNotesExtension

Parameters:

version - of the release to generate notes for

updateReleaseNotes

public void updateReleaseNotes(java.lang.String version)

Description copied from interface: ReleaseNotesExtension

Generates incremental release notes content using ReleaseNotesExtension.getReleaseNotes(String) )} and appends it to the top of release notes file.

Specified by:

updateReleaseNotes in interface ReleaseNotesExtension

Parameters:

version - of the release to generate notes for

getCompleteReleaseNotes

public java.lang.String getCompleteReleaseNotes()

getReleaseNotesFile

public java.io.File getReleaseNotesFile()

Description copied from interface: ReleaseNotesExtension

The file where the release notes are kept.

Specified by:

getReleaseNotesFile in interface ReleaseNotesExtension

setReleaseNotesFile

public void setReleaseNotesFile(java.io.File file)

Description copied from interface: ReleaseNotesExtension

The file where the release notes are kept.

Specified by:

setReleaseNotesFile in interface ReleaseNotesExtension

getGitHubReadOnlyAuthToken

public java.lang.String getGitHubReadOnlyAuthToken()

Description copied from interface: ReleaseNotesExtension

GitHub read only auth token for getting the issue links.

Specified by:

getGitHubReadOnlyAuthToken in interface ReleaseNotesExtension

setGitHubReadOnlyAuthToken

public void setGitHubReadOnlyAuthToken(java.lang.String gitHubAuthToken)

Description copied from interface: ReleaseNotesExtension

GitHub read only auth token for getting the issue links.

Specified by:

setGitHubReadOnlyAuthToken in interface ReleaseNotesExtension

getGitHubLabelMapping

public java.util.Map<java.lang.String,java.lang.String> getGitHubLabelMapping()

Description copied from interface: ReleaseNotesExtension

The mapping of "GitHub label" to human readable and presentable name. The order of labels is important and will influence the order in which groups of issues are generated in release notes. Examples: ['java-9': 'Java 9 support', 'BDD': 'Behavior-Driven Development support']

Specified by:

getGitHubLabelMapping in interface ReleaseNotesExtension

setGitHubLabelMapping

public void setGitHubLabelMapping(java.util.Map<java.lang.String,java.lang.String> gitHubLabelMapping)

Description copied from interface: ReleaseNotesExtension

See ReleaseNotesExtension.getGitHubLabelMapping().

Specified by:

setGitHubLabelMapping in interface ReleaseNotesExtension

getGitHubRepository

public java.lang.String getGitHubRepository()

Description copied from interface: ReleaseNotesExtension

GitHub repository, for example: "mockito/mockito"

Specified by:

getGitHubRepository in interface ReleaseNotesExtension

setGitHubRepository

public void setGitHubRepository(java.lang.String gitHubRepository)

Description copied from interface: ReleaseNotesExtension

GitHub repository, for example: "mockito/mockito"

Specified by:

setGitHubRepository in interface ReleaseNotesExtension