Hi, On Mon, Dec 15, 2008 at 8:26 PM, Mattmann, Chris A <[email protected]> wrote: > +1, I agree with Grant's comment. I also like the simplicity of having a > text file, separate of JIRA. What I find quite often (we use JIRA at work, > and deploy our open source software on various projects) is that folks don't > know what JIRA is, or care, but they like having a text file that comes > along with the release that they can refer to, and at least get a high level > view of what's going on in terms of updates and features for a release.
Agreed on the importance of having high level release notes in writing. However, I don't think that the current CHANGES.txt format of just listing the resolved issues is any better than the report from Jira. > Sure, JIRA can generate that file for you, using the release notes, but like > Grant said, it takes out the (some guy X via some committer Y), or (some > committer Y) comments, which are nice to give folks credit. Jira also has a pretty good contribution report (see [1] for the 0.2 release) where you can see all the people who've contributed to a release. I'm not saying that we should use these reports as-is as the only release notes, but since they already cover all the information we have in the current CHANGES.txt file I don't see much point in manually maintaining the file in it's current format. See the end of this message for a quick draft of what a higher level changelog could look like (using 0.2 as the example). I would much rather see us producing such a document than just mechanically listing fixed issues in the current CHANGES.txt. [1] https://issues.apache.org/jira/secure/ConfigureReport.jspa?versionId=12312902&selectedProjectId=12310631&reportKey=com.sourcelabs.jira.plugin.report.contributions%3Acontributionreport&Next=Next BR, Jukka Zitting ---- What's new in Apache Tika 0.2 ============================= Apache Tika 0.2 is an incremental feature release. The most notable changes in this release are: * The Microsoft Excel parser now supports partial streaming (per sheet) and makes cell hyperlinks available as XHTML <a/> tags. * The HTML parser now produces proper XHTML SAX events, extracts <head/> metadata better, and avoids including script or style information in the extracted text content. * The OpenDocument parser now supports streaming and structured content. * New parsers for the following document formats: - Microsoft Outlook and Visio documents - MP3 (ID3), WAV, AIFF, AU and MIDI audio files - zip, jar and tar archives - Java .class files * Tika now supports Gzip and Bzip2 decompression. * The new ParsingReader class makes the extracted text content of a document available as a java.io.Reader. This is especially useful for integration with Lucene Java that uses the Reader class for reading text to be indexed. * The new ExternalParser class allows external parser programs to be invoked through the Tika Parser API. * Tika now has simple command line and graphical user interfaces designed for easy testing or scripting of parsing functionality. * A retrotranslated version of Tika is now available for use in Java 1.4 environments. See http://tinyurl.com/tika-0-2-notes for more details on all resolved issues. Credits ------- The following people have contributed to this release by committing changes, by submitting patches, or by commenting on the issues resolved in the release. Dave Meikle Jukka Zitting Uwe Schindler Julien Nioche Niall Pemberton Sami Siren Rida Benjelloun Chris Hostetter Mats Norén Chris A. Mattmann Litrik De Roy Bertrand Delacretaz Karl Heinz Marbaise See http://tinyurl.com/tika-0-2-credits for more details on the contributions.
