Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.41 KB

RELEASING.md

File metadata and controls

35 lines (28 loc) · 1.41 KB
Raw

JTS Release Guide

This guide is intended for JTS project maintainers, to assist them in preparing releases of the project.

Release Checklist

Preparation

  1. Create a Release Milestone
    1. tag it to Issues and PRs wanted in the release
  2. Confirm Maven build executes with no errors
    1. mvn clean install

Update Artifacts

  1. Update the Version History, to record significant changes
  2. Set the version number in the following artifacts:
    1. Java class org.locationtech.jts.JTSVersion
    2. Maven POMs (run the Maven release plugin at project root: mvn versions:set -DnewVersion=<version> )
  3. Review scripts in bin to confirm correctness
  4. Commit changes back to the repo

Create Release Artifacts

  1. Execute the final Maven release build
    1. mvn clean install

Deploy the Release

  1. Create a JTS GitHub release
    1. Add release artifacts
    2. Update release notes
  2. Release to Maven Central with the release property and profile
    1. mvn clean install -Drelease
  3. Update Javadoc on JTS Github IO
    1. Javadoc is generated by the Maven build
    2. Update by: check out gh-pages branch; copy new Javadoc; commit