Differences between revisions 2 and 3
Revision 2 as of 2006-06-27 14:45:29
Size: 524
Comment: Don't need to say Derby, this is the Derby wiki.
Revision 3 as of 2007-05-01 14:25:15
Size: 711
Comment:
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
 * Edit the JIRA issue to check the "release note needed" checkbox
 * Add a comment to the JIRA issue, with the information as suggested by ReleaseNoteFormat
 * Somebody intends to run some sort of a JIRA report at some point, collect up all these special comments, and edit them into a simple document.
 * 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.

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.

ReleaseNoteProcess (last edited 2018-03-24 22:43:44 by RichardHillegas)