[GitHub] [maven-release] nielsbasjes opened a new pull request #104: [MRELEASE-1078] Conventional commits

[GitBox <gi...@apache.org>]

nielsbasjes opened a new pull request #104:
URL: https://github.com/apache/maven-release/pull/104


   Following this checklist to help us incorporate your 
   contribution quickly and easily:
   
    - [x] Make sure there is a [JIRA issue](https://issues.apache.org/jira/browse/MRELEASE-1078) filed 
          for the change (usually before you start working on it).  Trivial changes like typos do not 
          require a JIRA issue.  Your pull request should address just this issue, without 
          pulling in other changes.
    - [x] Each commit in the pull request should have a meaningful subject line and body.
    - [x] Format the pull request title like `[MJAVADOC-XXX] - Fixes bug in ApproximateQuantiles`,
          where you replace `MJAVADOC-XXX` with the appropriate JIRA issue. Best practice
          is to use the JIRA issue title in the pull request title and in the first line of the 
          commit message.
    - [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
    - [ ] Run `mvn clean verify -Prun-its` to make sure basic checks pass. A more thorough check will 
          be performed on your pull request automatically.
   
   Current status is that the `update-versions` IT tests fail and I do not understand why yet.
   ```
   [ERROR] The following builds failed:
   [ERROR] *  projects/update-versions/MRELEASE-611/pom.xml
   [ERROR] *  projects/update-versions/MRELEASE-555/pom.xml
   [ERROR] *  projects/update-versions/MRELEASE-976/pom.xml
   [ERROR] *  projects/update-versions/MRELEASE-783/pom.xml
   ```
   
   If your pull request is about ~20 lines of code you don't need to sign an
   [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
   please ask on the developers list.
   
   To make clear that you license your contribution under 
   the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
   you have to acknowledge this by using the following check-box.
   
    - [x] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
   
    - [x] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   
   
   This my implementation on creating the option to follow the ideas of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to automatically determine the next version.
   
   This patch assumes the required changes for maven-scm are available:
   - Jira issue [SCM-977](https://issues.apache.org/jira/browse/SCM-977) 
   - Pull request https://github.com/apache/maven-scm/pull/135
   
   
   Summary of the changes:
   - Extended the VersionPolicyRequest to include the SCM information.
   - New version policy that retrieves the ChangeLog from SCM (which includes the commit messages and the tags).
   - An optional configuration string `projectVersionPolicyConfig` that contains the optional config for the version policy. NOTE: I have tried to make it a clean addition of the configuration for the maven-release-plugin but I have not been successful in adding the extra config schema to the plugin. So for now it is a `String` which (because it is XML) must be included as CDATA.
   - I've added an integration test that shows it works and what the configuration looks like.
   
   
   I'm really looking forward to your feedback on how I can improve this.
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org