com.github.danielflower.mavenplugins.gitlog.renderers

Class AsciidocReleaseNotesRenderer

java.lang.Object

com.github.danielflower.mavenplugins.gitlog.renderers.FileRenderer

com.github.danielflower.mavenplugins.gitlog.renderers.AsciidocReleaseNotesRenderer

All Implemented Interfaces:

ChangeLogRenderer

public class AsciidocReleaseNotesRenderer
extends FileRenderer

Asciidoc Renderer to get a*.md file.

The created asciidoc file will have - a document title (level 0), - bold tags - and commits in each line.

Asciidoc reference is http://asciidoctor.org/docs/

Output Example: = Maven GitLog Plugin changelog *maven-gitlog-plugin-1.4.11* 2012-03-17 07:33:55 +0100 Updated maven version in docs (Daniel Flower) ...

Table View example

== Maven GitLog Plugin changelog

|=== |Date | Merge |2017-11-23 07:34:02 +0100 |asciidoc also als table view (Marcel Widmer) + |2017-11-22 12:24:41 +0100 |update README (Marcel Widmer) + |2017-11-22 12:19:21 +0100 |Merge Commits Only (Marcel Widmer) +

|=== == *gitlog-maven-plugin-1.13.3* +

|=== |Date | Merge |2016-09-24 08:40:27 +0200 |Bumped release plugin version (Daniel Flower) + |2016-09-24 08:38:49 +0200 |Merge pull request #42 from orevial/asciidoc-support (GitHub) + |2016-09-22 16:33:27 +0200 |Add Asciidoc converter support (Olivier Revial) +

|===

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageConverter	messageConverter

Fields inherited from class com.github.danielflower.mavenplugins.gitlog.renderers.FileRenderer

log, writer

Constructor Summary

Constructors

Constructor and Description
AsciidocReleaseNotesRenderer(org.apache.maven.plugin.logging.Log log, File targetFolder, String filename, boolean fullGitMessage, MessageConverter messageConverter, String asciidocHeading, boolean asciidocTableView, String asciidocTableViewHeader1, String asciidocTableViewHeader2)

Method Summary

Modifier and Type	Method and Description
void	renderCommit(org.eclipse.jgit.revwalk.RevCommit commit)
void	renderFooter()
void	renderHeader(String reportTitle)
void	renderTableFooter()
void	renderTableHeader()
void	renderTag(org.eclipse.jgit.revwalk.RevTag tag)

Methods inherited from class com.github.danielflower.mavenplugins.gitlog.renderers.FileRenderer

close, convertStreamToString, loadResourceToString

Methods inherited from class java.lang.Object

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

Field Detail

messageConverter

protected final MessageConverter messageConverter

Constructor Detail

AsciidocReleaseNotesRenderer

public AsciidocReleaseNotesRenderer(org.apache.maven.plugin.logging.Log log,
                                    File targetFolder,
                                    String filename,
                                    boolean fullGitMessage,
                                    MessageConverter messageConverter,
                                    String asciidocHeading,
                                    boolean asciidocTableView,
                                    String asciidocTableViewHeader1,
                                    String asciidocTableViewHeader2)
                             throws IOException

Throws:

IOException

Method Detail

renderHeader

public void renderHeader(String reportTitle)
                  throws IOException

Throws:

IOException

renderTag

public void renderTag(org.eclipse.jgit.revwalk.RevTag tag)
               throws IOException

Throws:

IOException

renderCommit

public void renderCommit(org.eclipse.jgit.revwalk.RevCommit commit)
                  throws IOException

Throws:

IOException

renderTableHeader

public void renderTableHeader()
                       throws IOException

Throws:

IOException

renderTableFooter

public void renderTableFooter()
                       throws IOException

Throws:

IOException

renderFooter

public void renderFooter()
                  throws IOException

Throws:

IOException