/git-changelog-maven-plugin

Maven plugin that can generate a changelog, or releasenotes, from git repository

Primary LanguageJavaOtherNOASSERTION

Git Changelog Maven Plugin Build Status Maven Central

This is a Maven plugin for Git Changelog Lib.

Usage

There is a running example here.

Have a look at the pom.xml where you will find some more examples.

Here is and example that will generate a CHANGELOG.md.

  <build>
    <plugins>
      <plugin>
        <groupId>se.bjurr.gitchangelog</groupId>
        <artifactId>git-changelog-maven-plugin</artifactId>
        <version>1.50</version>
        <executions>
          <execution>
            <id>GenerateGitChangelog</id>
            <phase>generate-sources</phase>
            <goals>
              <goal>git-changelog</goal>
            </goals>
            <configuration>
              <!-- A file on filesystem //-->
              <file>CHANGELOG.md</file>

              <!-- Or post to MediaWiki //-->
              <mediaWikiUsername>tomas</mediaWikiUsername>
              <mediaWikiPassword>tomaskod</mediaWikiPassword>
              <mediaWikiUrl>http://localhost/mediawiki</mediaWikiUrl>
              <mediaWikiTitle>Tomas Title</mediaWikiTitle>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

To generate changelog, just run:

mvn generate-sources

More documentation can be found in the Git Changelog Lib.

Developer instructions

To make a release, first run:

mvn release:prepare -DperformRelease=true
mvn release:perform

Then release the artifact from staging. More information here.