Code

test that announcement.txt is pure ASCII, required at least up to
[roundup.git] / doc / announcement.txt
index 8bf1675b9cbcde246870a6c33bace67a2ff551f7..14e7529eee6d7ecc1143bc0e5e2b34b140e7a955 100644 (file)
@@ -1,51 +1,61 @@
-=====================================================
-SC-Track Roundup 0.5 beta1 - an issue tracking system
-=====================================================
-
-Note: This is the first of two beta releases of the newest version of Roundup.
-It is strongly recommended that you maintain your existing 0.4 installation if
-you have one, and run 0.5 on a copy of the database. If you are upgrading from
-0.4, you must read doc/upgrading.txt!
-
-Roundup requires python 2.1.1 for correct operation. Support for dumbdbm
-requires python 2.1.2 or 2.2. 2.1.3 and 2.2.1 are recommended.
-
-A lot has been done since 0.4:
-
-- new backend for metakit (thanks Gordon McMillan)
-- new backend for gadfly (it's as done as it's going to get)
-- further split the *dbm backends from the core code, allowing easier
-  non-dict-like backends (eg metakit, RDB)
-- implemented and used the new access control mechanisms (Permissions, Roles)
-- switched templating to use Zope's PageTemplates (yay!)
-- switched to sessions for web authentication
-- added Boolean and Number types
-- full-text search may also search certain String properties
-- fixed the journal bloat
-- updated design document for new access controls
-- updated customisation document, including more examples
-- entire database export and import (incl files)
-- better mailgw help message (feature request #558562)
-- re-enabled link backrefs from messages (feature request #568714)
-- the page layout is now templatable
-- re-worked cgi interface to abstract out the explicit "issue" interface
-- have index page handle mid-page errors better so header and footer are
-  still visible
-- saving of named search queries
-- we handle "not found", access and item page render errors better
-- fixed double-submit by having new-item-submit redirect at end
-- daemonify roundup-server (fork, logfile, pidfile)
-- modify cgitb to display PageTemplate errors better
-- rename to "instance" to "tracker"
-- have roundup.cgi pick up tracker config from the environment 
-- revamped look and feel in web interface
-- cleaned up stylesheet usage
-- several bug fixes and documentation fixes
+I'm proud to release version 1.4.16 of Roundup which introduces some
+minor features and, as usual, fixes some bugs:
 
+Features:
+
+- allow trackers to override the classes used to render properties in
+  templating per issue2550659 (thanks Ezio Melotti)
+- new mailgw configuration item "subject_updates_title": If set to "no"
+  a changed subject in a reply to an issue will not update the issue
+  title with the changed subject. Thanks to Arkadiusz Kita and Peter
+  Funk for requesting the feature and discussing the implementation.
+  http://thread.gmane.org/gmane.comp.bug-tracking.roundup.user/10169
+- new rdbms config item sqlite_timeout makes the previously hard-coded
+  timeout of 30 seconds configurable. This is the time a client waits
+  for the locked database to become free before giving up. Used only for
+  SQLite backend.
+- new mailgw config item unpack_rfc822 that unpacks message attachments
+  of type message/rfc822 and attaches the individual parts instead of
+  attaching the whole message/rfc822 attachment to the roundup issue.
+
+Fixed:
+
+- fixed reporting of source missing warnings
+- relevant tests made locale independent, issue2550660 (thanks
+  Benni Baermann for reporting).
+- fix for incorrect except: syntax, issue2550661 (thanks Jakub Wilk)
+- No longer use the root logger, use a logger with prefix "roundup",
+  see http://thread.gmane.org/gmane.comp.bug-tracking.roundup.devel/5356
+- improve handling of '>' when URLs are converted to links, issue2550664
+  (thanks Ezio Melotti)
+- fixed registration, issue2550665 (thanks Timo Paulssen)
+- make sorting of multilinks in the web interface more robust, issue2550663
+- Fix charset of first text-part of outgoing multipart messages, thanks Dirk
+  Geschke for reporting, see
+  http://thread.gmane.org/gmane.comp.bug-tracking.roundup.user/10223
+- Fix handling of incoming message/rfc822 attachments. These resulted in
+  a weird mail usage error because the email module threw a TypeError
+  which roundup interprets as a Reject exception. Fixes issue2550667.
+  Added regression tests for message/rfc822 attachments with and without
+  configured unpacking (mailgw unpack_rfc822, see Features above)
+  Thanks to Benni Baermann for reporting.
+- Allow search_popup macro to work with all db classes, issue2550567
+  (thanks John Kristensen)
+- lower memory footprint for (journal-) import
+
+If you're upgrading from an older version of Roundup you *must* follow
+the "Software Upgrade" guidelines given in the maintenance documentation.
+
+Roundup requires python 2.3 or later (but not 3+) for correct operation.
+
+To give Roundup a try, just download (see below), unpack and run::
+
+    roundup-demo
+
+Release info and download page:
+     http://cheeseshop.python.org/pypi/roundup
 Source and documentation is available at the website:
-     http://roundup.sourceforge.net/
-Release Info (via download page):
-     http://sourceforge.net/projects/roundup
+     http://roundup-tracker.org/
 Mailing lists - the place to ask questions:
      http://sourceforge.net/mail/?group_id=31577
 
@@ -53,14 +63,14 @@ Mailing lists - the place to ask questions:
 About Roundup
 =============
 
-Roundup is a simple-to-use and -install issue-tracking system with 
-command-line, web and e-mail interfaces. It is based on the winning design 
+Roundup is a simple-to-use and -install issue-tracking system with
+command-line, web and e-mail interfaces. It is based on the winning design
 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
 
-Note: Ping is not responsible for this project. The contact for this project 
-is richard@users.sourceforge.net.
+Note: Ping is not responsible for this project. The contact for this
+project is richard@users.sourceforge.net.
 
-Roundup manages a number of issues (with flexible properties such as 
+Roundup manages a number of issues (with flexible properties such as
 "description", "priority", and so on) and provides the ability to:
 
 (a) submit new issues,
@@ -70,11 +80,11 @@ Roundup manages a number of issues (with flexible properties such as
 The system will facilitate communication among the participants by managing
 discussions and notifying interested parties when issues are edited. One of
 the major design goals for Roundup that it be simple to get going. Roundup
-is therefore usable "out of the box" with any python 2.1+ installation. It
-doesn't even need to be "installed" to be operational, though a
-disutils-based install script is provided.
+is therefore usable "out of the box" with any python 2.3+ (but not 3+)
+installation. It doesn't even need to be "installed" to be operational,
+though an install script is provided.
 
 It comes with two issue tracker templates (a classic bug/feature tracker and
-a help desk) and five database back-ends (anydbm, bsddb, bsddb3, metakit and
-gadfly). 
+a minimal skeleton) and four database back-ends (anydbm, sqlite, mysql
+and postgresql).