In the future, our build process will be automatically
generating release notes. To save you (not me!) time, please follow these
steps when commenting your commits to CVS.
Generating
Release Notes
Generating
release notes is easy - promoteToEclipse.sh does it for you!
However, there are a few simple steps to follow to ensure the generated content
is accurate & non-duplicative. Here's the general process for closing a bug
and using Bugzilla & CVS to provide the information required to generate
release notes.
- Working in Eclipse, fix your code. Test
is as much as possible before committing it to CVS.
- Commit your change(s) to CVS, using the
bug's number in square brackets to begin your commit comment, eg:
[127509] javadocs now available
- Note that you can include multiple bugs
(each number on its own line) and comments are not required. The information
that will appear in the release notes comes from the bug's Summary field,
not your CVS comments.
- Browse to the bug's webpage, and assign
it the status Assigned. This tells the release notes generator that this is a bug which
should be included in the release notes this week. Your bugzilla comment
could be something like:
Committed to CVS
- Produce a build, and promote it. Unless
you use the -nodocs flag, release notes will be generated automatically and will
appear in /cvsroot/org.eclipse/www/emft/news/.
- You can also use the -since flag to
manually identify the start date & time used to generate the list of
bugs. If omitted, the start will be the timestamp of the previous build as
identified in /cvsroot/org.eclipse/www/emft/news/news.xml.
- Verify that the contents of your
project's release notes are correct. Depending on the time you closed the
bug relative to the time the build was done, you may find duplicate bugs missing bugs.
This can be corrected by editing the appropriate release-notes-[subproject].xml file.
- In order to prevent bugs from being added
to the release notes over and over, every week you should ensure any Assigned bugs
which are available in a released build are marked Fixed.
The above was taken from EMFT’s build procedures: http://wiki.eclipse.org/index.php/EMFT_Procedures#Release_Process
The contents of this e-mail are intended for the named addressee only. It contains information that may be confidential. Unless you are the named addressee or an authorized designee, you may not copy or use it, or disclose it to anyone else. If you received it in error please notify us immediately and then destroy it.
