File: RELEASING.md

package info (click to toggle)
jts 1.16.1+ds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 37,984 kB
  • sloc: java: 87,635; xml: 27,093; ruby: 82; sh: 11; makefile: 3
file content (35 lines) | stat: -rw-r--r-- 1,448 bytes parent folder | download
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
# 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](https://github.com/locationtech/jts/milestones)
   1. tag it to Issues and PRs wanted in the release
1. Confirm Maven build executes with no errors
   1. `mvn clean install`

### Update Artifacts
1. Update the [Version History](https://github.com/locationtech/jts/blob/master/doc/JTS_Version_History.html), to record significant changes
1. Set the version number in the following artifacts:
   1. Java class `org.locationtech.jts.JTSVersion`
   1. Maven POMs (run the Maven release plugin at project root: `mvn versions:set -DnewVersion=<version>` )
1. Review scripts in `bin` to confirm correctness
1. 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](https://github.com/locationtech/jts/releases)
   1. Add release artifacts
   1. Update release notes
1. Release to Maven Central with the release property and profile 
   1. `mvn clean install -Drelease `
1. Update [Javadoc on JTS Github IO](http://locationtech.github.io/jts/javadoc/)
   1. Javadoc is generated by the Maven build
   1. Update by: check out [`gh-pages`](https://github.com/locationtech/jts/tree/gh-pages) branch; copy new Javadoc; commit