org.mockito.release.notes.format

Class ReleaseNotesFormatters

java.lang.Object

org.mockito.release.notes.format.ReleaseNotesFormatters

public class ReleaseNotesFormatters
extends java.lang.Object

Gives access to all release and version notes formatters

Constructor Summary

Constructors

Constructor and Description
ReleaseNotesFormatters()

Method Summary

Modifier and Type	Method and Description
static SingleReleaseNotesFormatter	defaultFormatter(java.util.Map<java.lang.String,java.lang.String> labelMapping) Returns the default formatter for version notes data
static MultiReleaseNotesFormatter	detailedFormatter(java.lang.String introductionText, java.util.Map<java.lang.String,java.lang.String> labelMapping, java.lang.String vcsCommitsLinkTemplate) Returns the detailed formatter intended to use for all releases
static MultiReleaseNotesFormatter	notableFormatter(java.lang.String introductionText, java.lang.String detailedReleaseNotesLink, java.lang.String vcsCommitsLinkTemplate) Returns the concise formatter intended to use for notable releases

Methods inherited from class java.lang.Object

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

Constructor Detail

ReleaseNotesFormatters

public ReleaseNotesFormatters()

Method Detail

defaultFormatter

public static SingleReleaseNotesFormatter defaultFormatter(java.util.Map<java.lang.String,java.lang.String> labelMapping)

Returns the default formatter for version notes data

Parameters:

labelMapping - Mapping of label to descriptive label summary. Labels of the improvements (see Improvement.getLabels() are often short and not very descriptive. In final release notes we want descriptive sections of improvements. Mappings also allow controlling priority in presenting improvements - the formatter can use the order of label mappings. For example, 'noteworthy' labelled improvements on top.

notableFormatter

public static MultiReleaseNotesFormatter notableFormatter(java.lang.String introductionText,
                                                          java.lang.String detailedReleaseNotesLink,
                                                          java.lang.String vcsCommitsLinkTemplate)

Returns the concise formatter intended to use for notable releases

Parameters:

introductionText - text to be placed on the top of the release notes content

detailedReleaseNotesLink - link to detailed release notes used in the report

vcsCommitsLinkTemplate - template to generate link to vcs view of the commits. For example: "https://github.com/mockito/mockito/compare/{0}...{1}". When template is formatted, 1st arg will be "fromRevision", 2nd will be "toRevision".

detailedFormatter

public static MultiReleaseNotesFormatter detailedFormatter(java.lang.String introductionText,
                                                           java.util.Map<java.lang.String,java.lang.String> labelMapping,
                                                           java.lang.String vcsCommitsLinkTemplate)

Returns the detailed formatter intended to use for all releases

Parameters:

introductionText - text to be placed on the top of the release notes content

labelMapping - Mapping of label to descriptive label summary. Labels of the improvements (see Improvement.getLabels() are often short and not very descriptive. In final release notes we want descriptive sections of improvements. Mappings also allow controlling priority in presenting improvements - the formatter can use the order of label mappings. For example, 'noteworthy' labelled improvements on top.

vcsCommitsLinkTemplate - template to generate link to vcs view of the commits. For example: https://github.com/mockito/mockito/compare/{0}...{1}". When template is formatted, 1st arg will be "fromRevision", 2nd will be "toRevision".