Skip to content

Commit

Permalink
Added links to example reports
Browse files Browse the repository at this point in the history
  • Loading branch information
danielflower committed Sep 19, 2011
1 parent c58de09 commit 3c1cd4d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,16 @@ This plugin allows the creation of text and HTML changelogs based on the git log
phase this plugin can generate plaintext and HTML reports showing all the commits (with tags) from the local git
repository. These text files can then be sent to a web server or included during packaging.

Sample output
=============

Using the default plugin parameters, the changelog for this project looks like the following:

[HTML example](http://danielflower.github.com/maven-gitlog-plugin/samples/changelog.html)
[Text example](http://danielflower.github.com/maven-gitlog-plugin/samples/changelog.txt)

Configuring the plugin
----------------------
======================

Add the following to your `<plugins>` section in your pom.xml file to generate changelog.txt and changelog.html
in your target folder:
Expand Down
3 changes: 0 additions & 3 deletions maven-gitlog-plugin.iml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@
<sourceFolder url="file://$MODULE_DIR$/target/generated-sources/annotations" isTestSource="false" />
<excludeFolder url="file://$MODULE_DIR$/${project.build.directory}/classes" />
<excludeFolder url="file://$MODULE_DIR$/${project.build.directory}/test-classes" />
<excludeFolder url="file://$MODULE_DIR$/target/apidocs" />
<excludeFolder url="file://$MODULE_DIR$/target/checkout" />
<excludeFolder url="file://$MODULE_DIR$/target/classes" />
<excludeFolder url="file://$MODULE_DIR$/target/javadoc-bundle-options" />
<excludeFolder url="file://$MODULE_DIR$/target/maven-archiver" />
<excludeFolder url="file://$MODULE_DIR$/target/surefire" />
<excludeFolder url="file://$MODULE_DIR$/target/surefire-reports" />
Expand Down

0 comments on commit 3c1cd4d

Please sign in to comment.