Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do you generate release notes? [closed]

[Question]
Does anyone product release notes via an automated process? If so how. Especially with continuous integration services. Do you just use a script to parse the log files for issues fixed for that release to create the appropriate text file?

[Background]
Recently I have implemented continuous integration for my hobby projects. As part of it I have had issue tracking reporting linked into my builds. However for releases I wish to do the same thing and have it produce a release notes files similar to the nhibernate release notes.txt which I find very clean.

[Example]

Build 1.2.1

Bug Fixed:

* [ID-1] - The system doesn't accept valid usernames 

Improvements:

* [ID-2] - Saving the file takes 3 minutes when it should take a few seconds.  

New Features:

* [ID-3] - Allow users to refresh the page using the F5 key. 

Task Completed:

* [ID-4] - Document undocumented configuration properties. 
like image 543
Gavin Chin Avatar asked Sep 11 '09 01:09

Gavin Chin


People also ask

Who is responsible to write release notes?

At one and two-person startups, the lead developer will be in charge of writing release notes. At medium-sized companies, this might be a product manager. While at large companies, release notes might be collaboratively handled by multiple product managers and the head of product or chief product officer.


1 Answers

Generally this sort of thing is done by issue tracking software. You track every new feature, every bugfix and every enhancement, assign them to a release and then generate release notes from the descriptions.

like image 140
cletus Avatar answered Oct 10 '22 13:10

cletus