how_to_release.txt

# Release information for Jannovar developers

## Read the following first

* http://java.dzone.com/articles/deploy-maven-central
* http://central.sonatype.org/pages/apache-maven.html

## Update the README.md file

Change the version in the readme.Do not forget the API version in the shield. 

## Update the CHANGELOG.md file

- Update the CHANGELOG.md file to reflect the new version.
- Create a new commit with this version.
- Do not create a git tag as this will be done by Maven below.

## Prepare the Release using Maven

    mvn release:prepare

Answer with the default everywhere but use "vMAJOR.MINOR" for giving the
tag name, e.g. "v0.15". Eventually, this will update the versions, create
a tag for the version and also push the tag to Github.

## Perform the Release

    mvn release:perform

Create the release and push it to Maven central/Sonatype.

## Releasing the Deployment

Read this:

* http://central.sonatype.org/pages/releasing-the-deployment.html

The publisher backend to Maven Central is here:

* https://oss.sonatype.org/

## Update README.md CHANGELOG.md

Open README.md and CHANGELOG.md and adjust the files accordingly

## Maven comments

* "mvn versions:set" is useful for bumping versions

## Troubleshooting

In the case that you see the error message `gpg: signing failed: Inappropriate ioctl for device` then you can fix this with the following Bash `export`.

```bash
export GPG_TTY=$(tty)
```