Good release notes are essential for users as they upgrade from one release to the next. Here's the procedure the Derby team uses to maintain useful release notes:
- For JIRAs which need a release note, you should turn on the "Release Note Needed" flag and attach a file called "releaseNote.html".
- The template for releaseNote.html will live in tools/release/templates/releaseNote.html.
- As you improve the wording of your release note, you simply attach a new version of releaseNote.html. The release documentation will include the last version of the release note.
Some additional discussion regarding this process can be found in DERBY-2570.