Generates release notes data model. The model can be used to generate human-readable release notes text.
| Type | Name and description |
|---|---|
java.util.Collection<ReleaseNotesData> |
generateReleaseNotesData(java.lang.String headVersion, java.util.Collection<java.lang.String> targetVersions, java.lang.String tagPrefix, java.util.Collection<java.lang.String> gitHubLabels, boolean onlyPullRequests)Generates release notes data model. |
Generates release notes data model.
headVersion - optional (nullable)
if provided the first release notes data on the result will be the head version
(data generated from HEAD)targetVersions - target versions, _important_:
1) must be ordered newest first,
2) last version will _not_ be included in resulting model,
it is only used to generate delta notes between last version and second-last version.
Example: for "1.3", "1.2", "1.1", only "1.3" and "1.2" will be included in the result.tagPrefix - tag prefix added to version so that it becomes vcs addressable revision (tag).
Typically it is "v". Empty string is ok, it means that there is no prefix.gitHubLabels - only include improvements with one of those labels.
The report should be concise so please include small set of labels.
If no labels are provided, _all_ improvements are included!onlyPullRequests - only include pull requests in the data