git-commit-id/git-commit-id-maven-plugin

Goal that can update the pom.xml to update/add git contributors to a <contributors> section

npiper opened this issue · 0 comments

npiper commented

Describe the idea (required)

Instead of manually maintaining a contributors section separately in the pom.xml use the

git shortlog --summary --numbered --email to add / parse a list of users as elements using the email id for uniqueness checks.

To simplify narrow down to it only being active for updates on a nominated branch history e.g. main

     9  npiper <solveapuzzledev@gmail.com>
<contributors>
    <contributor>
      <name>npiper</name>
      <email>solveapuzzledev@gmail.com</email>
    </contributor>
  </contributors>

Reference;
https://maven.apache.org/pom.html#Contributors

Tell us about the expected behaviour (required)

Append new git users who contribute per release on a main branch so it is visible in the POM and the site file on a maven site publish.

Maintaining / merging the list and deltas across multiple branches is likely too complex.

Context (optional)

I have an example build pipeline in my golden pom that might use this;

https://github.com/npiper/npiper-parent-org

Example that would have 'Contributors' added semi-automatically when using and adopting this plugin.
https://npiper.github.io/npiper-parent-pom/team-list.html

Post the pom.xml being updated there is a mvn site publish to gh-pages, commit and tag
https://npiper.github.io/npiper-parent-pom/project-info.html