ReleaseNotesGenerator (Github Release Notes Generator API)

wooga.gradle.releaseNotesGenerator.utils.ReleaseNotesGenerator

A generator class to create release notes from git log and pull request bodies.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`enum`	`ReleaseNotesGenerator.Template`

Constructor Summary

Constructors
Constructor and description
`ReleaseNotesGenerator (org.ajoberstar.grgit.Grgit git, org.kohsuke.github.GHRepository hub)`
`ReleaseNotesGenerator (org.ajoberstar.grgit.Grgit git, org.kohsuke.github.GHRepository hub, java.lang.String packageId)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.util.List<org.kohsuke.github.GHPullRequest>`	`fetchPullRequestsFromLog(java.util.List<org.ajoberstar.grgit.Commit> log)`
	`java.lang.String`	`generateReleaseNotes(org.ajoberstar.gradle.git.release.base.ReleaseVersion version, ReleaseNotesGenerator.Template template)` Generates a release note body message with given `version` and `Template`.
	`java.lang.String`	`generateReleaseNotes(java.util.List<org.ajoberstar.gradle.git.release.base.ReleaseVersion> versions, ReleaseNotesGenerator.Template template)` Generates a release note body message with given `versions` and `Template`.
	`protected ReleaseNoteBody`	`releaseNoteBodyFromVersion(org.ajoberstar.gradle.git.release.base.ReleaseVersion version)`
	`protected java.lang.String`	`render(ReleaseNoteBodies noteBodyModel, com.github.mustachejava.Mustache mustache)`
	`protected java.lang.String`	`render(ReleaseNoteBodies noteBodyModel, ReleaseNotesGenerator.Template template)`
	`protected java.lang.String`	`render(ReleaseNoteBodies noteBodyModel, java.io.File template)`

Inherited Methods Summary

Inherited Methods
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()`

- Constructor Detail
  - ReleaseNotesGenerator(org.ajoberstar.grgit.Grgit git, org.kohsuke.github.GHRepository hub)
  - ReleaseNotesGenerator(org.ajoberstar.grgit.Grgit git, org.kohsuke.github.GHRepository hub, java.lang.String packageId)
- Method Detail
  - protected java.util.List<org.kohsuke.github.GHPullRequest> fetchPullRequestsFromLog(java.util.List<org.ajoberstar.grgit.Commit> log)
  - java.lang.String generateReleaseNotes(org.ajoberstar.gradle.git.release.base.ReleaseVersion version, ReleaseNotesGenerator.Template template)
    
    Generates a release note body message with given version and Template. The generator will parse the git log from HEAD or current version to previous version and reads change lists from referenced pull requests. If no pull requests commits can be found, it will list the git log.
    Parameters:
    version - The ReleaseVersion to create the release note for
    template - value to use to generate the release notes
    Returns:
    a String containing the generated release notes
  - java.lang.String generateReleaseNotes(java.util.List<org.ajoberstar.gradle.git.release.base.ReleaseVersion> versions, ReleaseNotesGenerator.Template template)
    
    Generates a release note body message with given versions and Template. The generator will parse the git log from HEAD or current version to previous version and reads change lists from referenced pull requests. If no pull requests commits can be found, it will list the git log.
    Parameters:
    versions - A List object to create the release notes for
    template - value to use to generate the release notes
    Returns:
    a String containing the generated release notes
  - protected ReleaseNoteBody releaseNoteBodyFromVersion(org.ajoberstar.gradle.git.release.base.ReleaseVersion version)
  - protected java.lang.String render(ReleaseNoteBodies noteBodyModel, com.github.mustachejava.Mustache mustache)
  - protected java.lang.String render(ReleaseNoteBodies noteBodyModel, ReleaseNotesGenerator.Template template)
  - protected java.lang.String render(ReleaseNoteBodies noteBodyModel, java.io.File template)

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Github Release Notes Generator API

[Groovy] Class ReleaseNotesGenerator

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

ReleaseNotesGenerator(org.ajoberstar.grgit.Grgit git, org.kohsuke.github.GHRepository hub)

ReleaseNotesGenerator(org.ajoberstar.grgit.Grgit git, org.kohsuke.github.GHRepository hub, java.lang.String packageId)

Method Detail

protected java.util.List<org.kohsuke.github.GHPullRequest> fetchPullRequestsFromLog(java.util.List<org.ajoberstar.grgit.Commit> log)

java.lang.String generateReleaseNotes(org.ajoberstar.gradle.git.release.base.ReleaseVersion version, ReleaseNotesGenerator.Template template)

java.lang.String generateReleaseNotes(java.util.List<org.ajoberstar.gradle.git.release.base.ReleaseVersion> versions, ReleaseNotesGenerator.Template template)

protected ReleaseNoteBody releaseNoteBodyFromVersion(org.ajoberstar.gradle.git.release.base.ReleaseVersion version)

protected java.lang.String render(ReleaseNoteBodies noteBodyModel, com.github.mustachejava.Mustache mustache)

protected java.lang.String render(ReleaseNoteBodies noteBodyModel, ReleaseNotesGenerator.Template template)

protected java.lang.String render(ReleaseNoteBodies noteBodyModel, java.io.File template)