BUILD.md

Branches

master = "Release" branch, contains always version that's release to Maven Central

develop = Developent time branch. All PRs should be targetted (and usually also started) from here.

gh-pages = Github internal branch containing

Building

To run the unit tests, execute goal:

mvn test

To run all tests, including the integration tests:

mvn verify

To install the plugin locally:

mvn install

To generate the documentation:

mvn site:site

Releasing

• update the version numbers, first the pom, then from other files and docs.

osx:

grep -rl 'sion>2.1.0</ver' ./ | xargs sed -i '' 's|sion>2.1.0</ver|sion>2.1.1</ver|g'

linux:

grep -rl 'sion>2.1.0</ver' ./ | xargs sed -i 's|sion>2.1.0</ver|sion>2.1.1</ver|g'

Last you should update those rows above.

• Sanity check the changes

git di

• Build project

mvn clean verify

• Generate site docs and check that site docs are alright from target/site/index.html

mvn site:site

• Commit to git

git commit -am "version 2.1.0"
git tag -a 2.1.0 -m "version 2.1.0"
git push
git push --tags

• update release notes

• Push site to github (See generate site docs below for prerequirements)

mvn site

• Send the material to Sonatype (see Deploy project to Sonatype below)

mvn deploy -Pdeploy

• do close and release from Staging Repository at https://oss.sonatype.org/index.html#welcome

Generate site docs

To generate the documentation and upload it to github, first configure your settings.xml

<servers>
  <server>
    <id>github</id>
    <username>GitHubLogin</username>
    <password>GitHubPassw0rd</password>
  </server>
</servers>

then:

mvn site

Deploy project to Sonatype

As a prerequisite, you need account at Sonatype Jira, gpg keys, and Sonatype servers configured to your settings.xml. See https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide

mvn deploy -Pdeploy

Then do close and release from Staging Repository at https://oss.sonatype.org/index.html#welcome