com.github.danielflower.mavenplugins.gitlog.renderers

Class MarkdownRenderer

java.lang.Object

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

com.github.danielflower.mavenplugins.gitlog.renderers.MarkdownRenderer

All Implemented Interfaces:

ChangeLogRenderer

public class MarkdownRenderer
extends FileRenderer

Markdown Renderer to get a*.md file. The created markdown file will have - a h1 heading, - bold tags - and commits in each line. Markdown reference is http://daringfireball.net/projects/markdown/ 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) ...

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
MarkdownRenderer(org.apache.maven.plugin.logging.Log log, File targetFolder, String filename, boolean fullGitMessage, MessageConverter messageConverter, boolean append)

Method Summary

Modifier and Type	Method and Description
void	renderCommit(org.eclipse.jgit.revwalk.RevCommit commit)
void	renderFooter()
void	renderHeader(String reportTitle)
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

MarkdownRenderer

public MarkdownRenderer(org.apache.maven.plugin.logging.Log log,
                        File targetFolder,
                        String filename,
                        boolean fullGitMessage,
                        MessageConverter messageConverter,
                        boolean append)
                 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

renderFooter

public void renderFooter()
                  throws IOException

Throws:

IOException