developer_guide.md

Developer Guide

Generate / update license file header

mvn license:update-file-header

Run local sonar analysis

mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar \
    -Dsonar.token=[token]

See analysis results at https://sonarcloud.io/dashboard?id=org.itsallcode%3Ahamcrest-mutliline-text-matcher

Check for updated dependencies / plugins

mvn versions:display-dependency-updates

mvn versions:display-plugin-updates

Publishing to Maven Central

1. Add the following to your ~/.m2/settings.xml:

   <settings>
       <servers>
           <server>
               <id>ossrh</id>
               <username>your-jira-id</username>
               <password>your-jira-pwd</password>
           </server>
       </servers>
       <profiles>
           <profile>
               <id>ossrh</id>
               <activation>
                   <activeByDefault>true</activeByDefault>
               </activation>
               <properties>
                   <gpg.executable>gpg</gpg.executable>
                   <gpg.passphrase>the_pass_phrase</gpg.passphrase>
               </properties>
           </profile>
       </profiles>
   </settings>

2. Checkout the main branch.

3. Update version in pom.xml, commit and push.

4. Run command

   mvn -DskipSigningArtifacts=false clean deploy

5. Create a release of the main branch on GitHub.

6. After some time the release will be available at Maven Central.