release-guide.md

Rugged Release Guide

This release guide is largely inspired from Hipparchus Release Guide and Orekit Release Guide. It lists the steps that have been used in the past to release a new version of Rugged. When in doubt ask the experts: Sébastien Dinot sebastien.dinot@csgroup.eu for website questions and Luc Maisonobe luc.maisonobe@csgroup.eu for everything else.

Prerequisites

1. Obtain private key of the Rugged Signing Key, key id: xxxxxxxxxxxxxxxxxx
2. Register for account on OSSRH and associate it with the Rugged project, see: https://central.sonatype.org/pages/ossrh-guide.html

If you need help with either, ask on the development section of the Rugged forum.

Once you have a SonaType OSS account, the corresponding credentials must be set in the servers section of your $HOME/.m2/settings.xml file, using an id of ossrh:

<servers>
  <server>
    <id>ossrh</id>
    <username>the user name to connect to the OSS site</username>
    <password>the encrypted password</password>
  </server>
</servers>

Use mvn -ep to generate an encrypted password.

Install Graphviz

Graphviz (dot) is used to generated diagrams of the technical documentation (static site).

Verify the status of develop branch

Before anything, check on the continuous integration site that everything is fine on develop branch:

• All tests pass;
• Code coverage is up to the requirements;
• There are no bugs, vulnerabilities or code smells.

If not, fix the warnings and errors first !

It is also necessary to check on the Gitlab CI/CD that everything is fine on develop branch (i.e. all stages are passed).

Prepare Git branch for release

Release will be performed on a dedicated branch, not directly on master or develop branch. So a new branch must be created as follows and used for everything else:

git branch release-X.Y
git checkout release-X.Y

Update maven plugins versions

Release is a good opportunity to update the maven plugin versions. They are all gathered at one place, in a set of properties in rugged/pom.xml, for instance: