improved changelog file

[KaiSchwarz-cnic]

We use the following plugin version/configuration:

<plugin>
  <groupId>info.plichta.maven.plugins</groupId>
  <artifactId>git-changelog-maven-plugin</artifactId>
  <version>0.4.0</version>
  <configuration>
           <outputFile>HISTORY.md</outputFile>
           <reportTitle>Changelog</reportTitle>
           <gitHubUrl>https://github.com/hexonet/java-sdk</gitHubUrl>
  </configuration>
</plugin>

and here the release plugin version/configuration:

<plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-release-plugin</artifactId>
          <version>2.5.3</version>
          <configuration>
            <tagNameFormat>v@{project.version}</tagNameFormat>
            <preparationGoals>clean git-changelog:git-changelog scm:checkin -DpushChanges=false -Dincludes=HISTORY.md -Dmessage="[maven-release-plugin] Update HISTORY.md" verify</preparationGoals>
            <completionGoals>git-changelog:git-changelog scm:checkin -DpushChanges=false -Dincludes=HISTORY.md -Dmessage="[maven-release-plugin] Update HISTORY.md"</completionGoals>
            <autoVersionSubmodules>true</autoVersionSubmodules>
            <useReleaseProfile>false</useReleaseProfile>
            <releaseProfiles>release</releaseProfiles>
            <goals>deploy</goals>
          </configuration>
        </plugin>

FYI: We use the nexus-staging-maven-plugin to publish versions on OSSRH.

Finally there are two potential issues I see a) the changelog is also generated for SNAPSHOT release. That's a matter of taste, but as SNAPSHOT releases are not part of the github tags it doesn't make a lot sense. that version doesn't exist then on github. /UPDATE: we always see the x.y.z-SNAPSHOT release at top, which is wrong as the last version was definitely x.y.z and not x.y.z-SNAPSHOT. b) We highly request a possibility to generate a complete changelog covering ALL release versions

Compare the below changelog files

• our nodejs SDK - https://github.com/hexonet/node-sdk/blob/master/HISTORY.md
• our java SDK - https://github.com/hexonet/java-sdk/blob/430b27ec443cfdc2aae740c136302ea33f34f165/HISTORY.md

The plugin used by the nodejs SDK to generate the changelog, does it really well. maybe worth to have a look at. Especially the linked versions are super useful.

Any help welcome! Thanks so much!

[KaiSchwarz-cnic]

in the meanwhile, I've replaced your plugin with executing the nodejs changelog generator through exec-maven-plugin which worked fine, but personally I would prefer getting things working with your plugin.