org.mockito.release.gradle.notes

Interface ReleaseNotesExtension

All Known Implementing Classes:

DefaultReleaseNotesExtension

public interface ReleaseNotesExtension

This extension object is added by ReleaseNotesPlugin. Example configuration:

  notes {
    notesFile = file("docs/release-notes.md")
    gitHubAuthToken = "secret"
    gitHubLabelMappings = ['java-9': 'Java 9 support', 'BDD': 'Behavior-Driven Development support']
  }
 

Method Summary

Modifier and Type	Method and Description
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 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 notesFile) The file where the release notes are kept.
void	updateReleaseNotes(java.lang.String version) Generates incremental release notes content using getReleaseNotes(String) )} and appends it to the top of release notes file.

Method Detail

getPreviousVersion

java.lang.String getPreviousVersion()

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

getReleaseNotes

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

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

Parameters:

version - of the release to generate notes for

updateReleaseNotes

void updateReleaseNotes(java.lang.String version)

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

Parameters:

version - of the release to generate notes for

getReleaseNotesFile

java.io.File getReleaseNotesFile()

The file where the release notes are kept.

setReleaseNotesFile

void setReleaseNotesFile(java.io.File notesFile)

The file where the release notes are kept.

getGitHubReadOnlyAuthToken

java.lang.String getGitHubReadOnlyAuthToken()

GitHub read only auth token for getting the issue links.

setGitHubReadOnlyAuthToken

void setGitHubReadOnlyAuthToken(java.lang.String gitHubAuthToken)

GitHub read only auth token for getting the issue links.

getGitHubLabelMapping

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

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']

setGitHubLabelMapping

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

See getGitHubLabelMapping().

getGitHubRepository

java.lang.String getGitHubRepository()

GitHub repository, for example: "mockito/mockito"

setGitHubRepository

void setGitHubRepository(java.lang.String gitHubRepository)

GitHub repository, for example: "mockito/mockito"