I just posted some information on a script I have been working on to generate a release summary to the asterisk-dev list.
In the past, when we made a new release of Asterisk, the only file that you had to get an idea of what changed in that release was the ChangeLog, which includes the developer oriented commit message for every change. There is also the CHANGES file which lists new features included in a new major release. Also, the release announcements generally contain a high level overview of some of the important changes.
In order to help improve visibility into what changes are being made, David Vossel and I have been working on a script that automatically generates a summary for a release. The intent would be to start generating these as a part of the release process and include them with every release. The intent is to provide something a bit more user friendly than the ChangeLog.
Currently, the script generates a document that includes the following information:
- The type of release (bug fix update, security update, etc.)
- People involved in making the release by coding, testing, or reporting issues.
- All issues closed from bugs.digium.com
- A list of “other changes”, that didn’t close out a bug report, and which bug reports these changes were related to, if any.
- A “diffstat”, which gives an overview of which files were changed, and by how much.
The script is pretty much ready to be integrated into the release process, but I wanted to present example output to everyone for feedback first. So, take a look at these examples and let me know what you think. The script generates both an HTML version, and a plain text version.
A bug-fix release:
A security release:
A feature release:
Digium, Inc. | Senior Software Engineer, Open Source Team Lead
445 Jan Davis Drive NW – Huntsville, AL 35806 – USA
Check us out at: http://www.digium.com & http://www.asterisk.org
This is an extremely useful tool. I will definitely be using the ‘Closed issues’ section as this will save a lot of time compared to going through the existing changelog . Great stuff – well done.
Looks good thanks!
BTW, nice to see your still alive. Its been a bit dead around here.
This seems great! Congratulations!
I have a suggestion: why don’t you sort the diffstat output so that the files are ordered by the number of changes? IMHO this would make easier to find the “most changed” files.
Thanks a lot!
Thanks for the feedback, everyone.
I checked the options available from the diffstat utility and having it sort by the number of lines changed is not an option Of course, I could sort it manually, but I think I’d rather just leave it sorted by filename. Hopefully the histogram is a helpful visual hint for finding the files that changed the most.
Mat, I know it has been a bit dead. Sorry about that. I got very caught up in an internal project for a while and a number of things, including this blog, were neglected. I should be back to posting regular updates on things now.