Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Release Procedure

Émile Grégoire edited this page Jun 11, 2020 · 12 revisions

prior to release

  1. run valgrind with all unit tests against GCC/Clang
  2. ensure that all documentation packages are up to date with any API/build changes
    • doxygen
    • javadoc
    • docs in C#
    • opendnp3 guide
  3. Ensure that GCC/Clang build with "-Wall -Werror" for x32 and x64 builds
  4. Check that the Nuget API key for Appveyor is still valid (expires every year)

performing the release

  1. Checkout the release branch and merge develop into it.

  2. Update version numbers in CMake. The .NET bindings automatically use this version number as well.

  3. Update version number in config/doxygen.config.

  4. Update version of here: https://github.com/dnp3/opendnp3-dnp4s-driver/blob/master/pom.xml

  5. Update the Changelog.

  6. Run the maven release plugin to update the versions in POMs and create the tags

cd java
mvn release:prepare

or to skip the tests:

mvn -Darguments=-DskipTests release:prepare  

Add the release version and new development (snapshot) version when prompted.

This will create two commits (one w/ release versions in POMs and another following it with the snapshot versions). It will also create a tag, e.g. "2.3.0".

  1. If all seems right:
git push origin release --tags
  1. Generate doxygen doxygen config/doxygen.config and publish it if this is a major release with any changes to the public API.

  2. Mark the new tag as a release via Github so users see it as such.

Clone this wiki locally