summaryrefslogtreecommitdiff
path: root/RELEASING.md
blob: 0df4aa5462fc9b65e75d5755828337e4f66e28f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
RELEASING
=========

These instructions serve as a reminder on how to release to Maven Central.

Process
-------

1. Increment the version number appropriately. Use [Semantic Versioning](http://semver.org/).

        VERSION=1.1
        mvn versions:set -DnewVersion=$VERSION

2. Verify the release to make sure all is well.

        mvn clean verify -P release

3. Commit and tag the latest release.

        git commit -am "Release $VERSION"
        git tag -a v$VERSION -m "Release $VERSION"

4. Deploy to Sonatype:

        mvn clean deploy -P release

5. Push commit and tag to GitHub

        git push origin master
        git push origin v$VERSION

6. Create a new Releases on GitHub. Use the tag you just created and optionally
   include a change log. Attach the compiled, sources, and javadoc jar files,
   along with the .asc signature files.

7. Prepare the master branch for the next release by incrementing the version number.

        VERSION=1.2-SNAPSHOT
        mvn versions:set -DnewVersion=$VERSION
        git commit -am "Incrementing the version to $VERSION"
        git push origin master