org.mockito.release.gradle

Class ReleaseConfiguration.ReleaseNotes

java.lang.Object

org.mockito.release.gradle.ReleaseConfiguration.ReleaseNotes

Enclosing class:

ReleaseConfiguration

public class ReleaseConfiguration.ReleaseNotes
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReleaseNotes()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFile() Release notes file relative path, for example: "docs/release-notes.md"
java.util.Collection<java.lang.String>	getIgnoreCommitsContaining() Release notes are generated based on information in commit messages.
java.util.Map<java.lang.String,java.lang.String>	getLabelMapping() Issue tracker label mappings.
void	setFile(java.lang.String file) See getFile()
void	setIgnoreCommitsContaining(java.util.Collection<java.lang.String> commitMessageParts) See getIgnoreCommitsContaining()
void	setLabelMapping(java.util.Map<java.lang.String,java.lang.String> labelMapping) See getLabelMapping()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReleaseNotes

public ReleaseNotes()

Method Detail

getFile

public java.lang.String getFile()

Release notes file relative path, for example: "docs/release-notes.md"

setFile

public void setFile(java.lang.String file)

See getFile()

getLabelMapping

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

Issue tracker label mappings. The mapping of issue tracker labels (for example "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']

setLabelMapping

public void setLabelMapping(java.util.Map<java.lang.String,java.lang.String> labelMapping)

See getLabelMapping()

getIgnoreCommitsContaining

public java.util.Collection<java.lang.String> getIgnoreCommitsContaining()

Release notes are generated based on information in commit messages. If a commit message contains any of texts from this collection, that commit will be ignored and not used for generating release notes.

setIgnoreCommitsContaining

public void setIgnoreCommitsContaining(java.util.Collection<java.lang.String> commitMessageParts)

See getIgnoreCommitsContaining()