Gives access to all release and version notes formatters
| Type | Name 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 | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Returns the default formatter for version notes data
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.Returns the detailed formatter intended to use for all releases
introductionText - text to be placed on the top of the release notes contentlabelMapping - 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".Returns the concise formatter intended to use for notable releases
introductionText - text to be placed on the top of the release notes contentdetailedReleaseNotesLink - link to detailed release notes used in the reportvcsCommitsLinkTemplate - 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".