Mercurial > p > roundup > code

annotate doc/announcement.txt @ 6160:9619d64c0351

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doc updates for customizing.txt, start of index generation customizing.txt: fix doc on schema.py. Documented obsolete db schema declaration/initial data method. doc on config.ini is incomplete. doc as such. Add doc for [rdbms]: backend, cache_size, sqlite_timeout document Interval schema type. Also change formatting for list of schema types to description list from regular list so types are more visible. add link to roundup wiki for schema chnge examples. fix formatting for postfix config. document Rest Access and Xmlrpc Access permissions; change classic schema.py example to include them. doc db/backend_name as obsolete, conf.py [rdbms] backend used instead. start adding index references conf.py: update copyright year index.txt: add link to genindex.html. _templates/layout.html: change code to make index output work. Not sure what the change does, just monkey pasting from sphinx basic/layout.html
author John Rouillard <rouilj@ieee.org>
date Mon, 11 May 2020 00:02:31 -0400
parents eb9d00db0923
children 043a8ffd79ad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
1 I'm proud to release version 2.0.0beta0 of the Roundup issue tracker
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
2 which has been possible due to the help of several contributors. This
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
3 release contains some major changes, so make sure to read
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
4 `docs/upgrading.txt
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
5 <http://www.roundup-tracker.org/dev-docs/upgrading.html>`_ to bring
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
6 your tracker up to date. The changes, as usual, include some new
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
7 features and many bug fixes.
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
8
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
9 You can download it with:
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
10
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
11 pip download roundup==2.0.0beta0
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
12
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
13 then unpack and test/install the tarball.
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
14
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
15 Among the notable improvements from the 1.6.1 release are:
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
16
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
17 Roundup is multilingual and will run under either Python 3 or
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
18 Python 2. If you want to use Python 3, you *must read* the Python 3
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
19 Support section in the upgrading doc. Depending on the database
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
20 backend you may have to export/import the tracker. Also you will
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
21 need to make sure your tracker's Python code is Python 3
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
22 compliant. Thanks to Joseph Myers with help from Christof Meerwald.
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
23
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
24 Roundup has a rest API to go along with the existing xmlrpc
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
25 API. See doc/rest.txt for details on configuring, authorizing
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
26 access (per role) and making a request. Thanks to Ralf
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
27 Schlatterbeck who integrated and updated Chau Nguyen's GSOC code.
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
28
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
29 PGP encryption is now done using the gpg module and not the
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
30 obsolete pyme library. Thanks to Christof Meerwald.
4394
d4cd0a264098 fixed reporting of source missing warnings
Richard Jones <richard@users.sourceforge.net>
parents: 4392
diff changeset
31
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
32 Use of mod_python is deprecated. Apache mod_wsgi documentation
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
33 has been updated along with gunicorn and uwsgi and is the
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
34 preferred mechanism.
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
35
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
36 jinja templates updated to bootstrap 4.4.1. Templates use
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
37 autoescape and translation library. Support for messages
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
38 written in markdown added. SimpleMDE used as markdown editor to
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
39 provide preview features. Thanks to Christof Meerwald.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
40
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
41 The file CHANGES.txt has a detailed list of feature additions and bug
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
42 fixes for each release. The most recent changes from there are at the
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
43 end of this announcement. Also see the information in
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
44 doc/upgrading.txt.
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
45
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
46 How You Can Help
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
47 ================
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
48
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
49 We are looking for one or two front end developers to kick the tires
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
50 on the rest interface. The rest interface is available by running
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
51 demo.py as described below. If you are interested in helping please
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
52 contact "rouilj+rit at ieee.org".
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
53
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
54 The Zope deployment mode has not had any testing under Python 3. We
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
55 are looking for community involvement to help get this deployment
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
56 mode validated. It may also have issues under Python 2. If you are
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
57 interested in helping with this please see:
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
58 https://issues.roundup-tracker.org/issue2141835
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
59
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
60 Email input using POP and IMAP modes need testing under Python 3
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
61 and Python 2.
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
62
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
63 We have new documentation for deploying with apache and mod_wsgi. It
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
64 needs testing and enhancement.
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
65
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
66 There are other documentation issues at:
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
67
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
68 https://issues.roundup-tracker.org/issue?@columns=title,id,activity,status&components=7&status=-1,1,2&@template=index&@action=search
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
69
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
70 If you find bugs, please report them to issues AT roundup-tracker.org
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
71 or create an account at https://issues.roundup-tracker.org and open a
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
72 new ticket. If you have patches to fix the issues they can be attached
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
73 to the email or uploaded to the tracker.
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
74
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
75 Upgrading
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
76 =========
3722
41feeed84caa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3721
diff changeset
77
2253
91118ac2fa7f pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2219
diff changeset
78 If you're upgrading from an older version of Roundup you *must* follow
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
79 all the "Software Upgrade" guidelines given in the doc/upgrading.txt
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
80 documentation.
2253
91118ac2fa7f pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2219
diff changeset
81
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
82 Roundup requires Python 2 newer than version 2.7.2 or Python 3 newer
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
83 than or equal to version 3.4 for correct operation.
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
84
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
85 The wsgi, server and cgi web deployment modes are the ones with the
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
86 most testing.
1291
bf8b2380adb3 added CGI :remove:<propname> and :add:<propname>...
Richard Jones <richard@users.sourceforge.net>
parents: 1286
diff changeset
87
1780
d2801a2b0a77 Initial implementation (half-baked) at new Tracker instance.
Richard Jones <richard@users.sourceforge.net>
parents: 1744
diff changeset
88 To give Roundup a try, just download (see below), unpack and run::
d2801a2b0a77 Initial implementation (half-baked) at new Tracker instance.
Richard Jones <richard@users.sourceforge.net>
parents: 1744
diff changeset
89
4601
116113c4bb05 doc/announcement.txt: Fix command to run the demo.
anatoly techtonik <techtonik@gmail.com>
parents: 4600
diff changeset
90 python demo.py
282
fb1b67a8fd98 Reverted a change in hyperdb...
Richard Jones <richard@users.sourceforge.net>
parents: 281
diff changeset
91
3537
d819ff1b3116 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3536
diff changeset
92 Release info and download page:
5756
e48b039b0ec0 issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents: 5349
diff changeset
93 https://pypi.org/project/roundup
282
fb1b67a8fd98 Reverted a change in hyperdb...
Richard Jones <richard@users.sourceforge.net>
parents: 281
diff changeset
94 Source and documentation is available at the website:
4436
528ace81fd16 fix URL in announcement; fix handling of unicode in announcement
Richard Jones <richard@users.sourceforge.net>
parents: 4432
diff changeset
95 http://roundup-tracker.org/
286
2313560b8477 Initial cut at trying to handle people responding to CC'ed messages...
Richard Jones <richard@users.sourceforge.net>
parents: 283
diff changeset
96 Mailing lists - the place to ask questions:
5756
e48b039b0ec0 issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents: 5349
diff changeset
97 https://sourceforge.net/p/roundup/mailman/
286
2313560b8477 Initial cut at trying to handle people responding to CC'ed messages...
Richard Jones <richard@users.sourceforge.net>
parents: 283
diff changeset
98
2313560b8477 Initial cut at trying to handle people responding to CC'ed messages...
Richard Jones <richard@users.sourceforge.net>
parents: 283
diff changeset
99
282
fb1b67a8fd98 Reverted a change in hyperdb...
Richard Jones <richard@users.sourceforge.net>
parents: 281
diff changeset
100 About Roundup
fb1b67a8fd98 Reverted a change in hyperdb...
Richard Jones <richard@users.sourceforge.net>
parents: 281
diff changeset
101 =============
241
54da66e7e583 Added the release announcement text to the repo...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
103 Roundup is a simple-to-use and install issue-tracking system with
2030
3f6e27e9b063 tweaks to make un-quoted-printable-aware readers bitch and moan to me less
Richard Jones <richard@users.sourceforge.net>
parents: 1780
diff changeset
104 command-line, web and e-mail interfaces. It is based on the winning design
241
54da66e7e583 Added the release announcement text to the repo...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
54da66e7e583 Added the release announcement text to the repo...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
106
2030
3f6e27e9b063 tweaks to make un-quoted-printable-aware readers bitch and moan to me less
Richard Jones <richard@users.sourceforge.net>
parents: 1780
diff changeset
107 Note: Ping is not responsible for this project. The contact for this
3f6e27e9b063 tweaks to make un-quoted-printable-aware readers bitch and moan to me less
Richard Jones <richard@users.sourceforge.net>
parents: 1780
diff changeset
108 project is richard@users.sourceforge.net.
241
54da66e7e583 Added the release announcement text to the repo...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109
2030
3f6e27e9b063 tweaks to make un-quoted-printable-aware readers bitch and moan to me less
Richard Jones <richard@users.sourceforge.net>
parents: 1780
diff changeset
110 Roundup manages a number of issues (with flexible properties such as
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 580
diff changeset
111 "description", "priority", and so on) and provides the ability to:
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 580
diff changeset
112
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 580
diff changeset
113 (a) submit new issues,
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 580
diff changeset
114 (b) find and edit existing issues, and
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 580
diff changeset
115 (c) discuss issues with other participants.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 580
diff changeset
116
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
117 The system facilitates communication among the participants by managing
241
54da66e7e583 Added the release announcement text to the repo...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
118 discussions and notifying interested parties when issues are edited. One of
54da66e7e583 Added the release announcement text to the repo...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
119 the major design goals for Roundup that it be simple to get going. Roundup
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
120 is therefore usable "out of the box" with any Python 2.7.2+ (or 3.4+)
4226
d0a3ac73b4c1 clarify python version
Richard Jones <richard@users.sourceforge.net>
parents: 4117
diff changeset
121 installation. It doesn't even need to be "installed" to be operational,
d0a3ac73b4c1 clarify python version
Richard Jones <richard@users.sourceforge.net>
parents: 4117
diff changeset
122 though an install script is provided.
241
54da66e7e583 Added the release announcement text to the repo...
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
123
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
124 It comes with five issue tracker templates
1102
d94bd5369456 first cut at 0.5 announcement
Richard Jones <richard@users.sourceforge.net>
parents: 797
diff changeset
125
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
126 * a classic bug/feature tracker
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
127 * a more extensive devel tracker for bug/features etc.
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
128 * a responsive version of the devel tracker
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
129 * a jinja2 version of the devel template (work in progress)
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
130 * a minimal skeleton
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
131
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
132 and supports four database back-ends (anydbm, sqlite, mysql and postgresql).
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
133
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
134 Recent Changes
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
135 ==============
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
136
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
137 Features:
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
138
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
139 - Allow to pass additional headers to nosymessage, nice if a message
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
140 needs to be marked as urgent or similar, e.g., Outlook uses an
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
141 "Importance" header, when set to "high" it highlights the message.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
142 (Ralf Schlatterbeck)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
143 - issue2550926 - Original author adding a second message shouldn't set
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
144 status to 'chatting'. See upgrading.txt for details. (John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
145 - issue2550919 - Anti-bot signup using 4 second delay. New config.ini
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
146 param [web] registration_delay must be set to 0 if template
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
147 user.register.html is not modified. See upgrading.txt for details.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
148 - Reimplement -u <login>[:<password>]. This opens the database as the
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
149 user and applies expected permissions. It also creates history
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
150 entries for the user. Note that the password is unused, no mention
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
151 of it is in the spec that I can find, so not sure what it was
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
152 supposed to be used for as the CLI has full access to the files so a
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
153 password check is not useful. An edge case is when the login has a :
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
154 in it. In this case it may not work as expected. So don't do that.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
155 - Implement Cache-Control headers for static files. Allows tracker
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
156 admin to control caching for css, js and other static files. See
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
157 customizing.html. The use is documented in the section describing
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
158 how to use interfaces.py.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
159 - issue2551071 Update jinja template to bootstrap 4. Updated to 4.4.1.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
160 The pull request has been around for a while. (Patch: Paul Spooren;
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
161 templates merged and additional changes by Christof Meerwald; other
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
162 merged by John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
163 - Add config option 'http_auth_convert_realm_to_lowercase'
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
164 If usernames consist of a name and a domain/realm part of the form
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
165 user@realm and we're using REMOTE_USER for authentication (e.g. via
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
166 Kerberos), convert the realm part of the incoming REMOTE_USER to
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
167 lowercase before matching against the roundup username. This allows
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
168 roundup usernames to be lowercase (including the realm) and still
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
169 follow the Kerberos convention of using an uppercase realm. In
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
170 addition this is compatible with Active Directory which stores the
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
171 username with realm as UserPrincipalName in lowercase.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
172 - Cleaned up the WSGI interface implementation by separating the
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
173 request handler from the request displatcher. Also allow
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
174 customisation of tracker instance creation via an overridable
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
175 "get_tracker" context manager.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
176 - Allow transitive properties in @fields in REST API. These transitive
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
177 properties may not cross Multilinks, e.g., when querying 'issue' the
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
178 property 'messages.author' is not allowed (because 'messages' is a
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
179 multilink). A multilink at the end (e.g. messages in the example) is
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
180 fine.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
181 - Added markdown rendering using markdown, markdown2 or mistune; use
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
182 SimpleMDE markdown editor in jinja2 template (Christof Meerwald)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
183 - Allow filtering by multiple date ranges or empty date. Date ranges are
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
184 separated by comma, an empty date is represented by '-'
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
185 - issue2551083 - Replace BaseException and Exception as base classes
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
186 with new RoundupException (inheriting from Exception) for most
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
187 roundup exceptions. (John Rouillard and Ralf Schlatterbeck on
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
188 request from Robert Klonner.)
5951
0a42163ac846 Final doc fixes and translation extraction.
John Rouillard <rouilj@ieee.org>
parents: 5949
diff changeset
189
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
190 Fixed:
5335
e7293df727dc Working through RELEASE.txt - updates for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5333
diff changeset
191
6137
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
192 - issue2550996 - Give better error message when running with -c
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
193 (install as windows service) and pywin32 is not importable. Could use
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
194 better testing on a windows box. (John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
195 - issue2550921 - Can create login name with , in it. Confuses nosy
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
196 list editing. Also can embed html tags. Updated userauditor.py
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
197 to prevent this. See updating.txt. (John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
198 - issue1344046 - Search for "All text" can't find some Unicode words
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
199 (John Rouillard, Ezio Melotti)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
200 - issue1195739 - search in russian does not work (John Rouillard, Ezio
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
201 Melotti)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
202 - issue2550920 - Registration with confirmation detects duplcate name
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
203 when using validation. Added option to allow detection of duplicate
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
204 username when the user tries to register. Previously user was
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
205 rejected when confirming registration. (John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
206 - French translation gave errors with Python 3 because of ISO-8859-1
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
207 character in .mo file header. (Joseph Myers)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
208 - Fix representation of boolean html attributes to be 'required'
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
209 rather than the xhtml form of 'required="required"'. Specify
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
210 (reverted attribute value same as attribute name or) attribute
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
211 value of None, to output attribute as boolean. (John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
212 Reverted (part of) this change. It breaks rendering of non-boolean
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
213 attributes (like name="name"). So only value of None renders
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
214 attribute properly as boolean. (Ralf Schlatterbeck)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
215 - issue2551076 - in responsive template, default searches for bugs and
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
216 tasks sets status=new default should be "don't care". (Report:
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
217 Ludwig Reiter; Fix: John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
218 - issue2551077 - In "jinja2" template: cannot login if German language
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
219 is used. Fixed three places where the value of a hidden @action
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
220 input field was translated. (Reported by Ludwig Reiter. John
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
221 Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
222 - Document security issues in xmlrpc interface in doc/xmlrpc.txt.
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
223 - Enable autoescape in the jinja2 template and use the i18n extension
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
224 for translations. (Report: John Rouillard; Fix: Christof Meerwald)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
225 - Cleanup code by linting using flake8. (John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
226 - Cleanup code by security linting using bandit. (John Rouillard)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
227 - issue2550912 - fixed missing query string in __came_from for jinja2
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
228 template. (Christof Meerwald)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
229 - issue2551019 - handle character set conversions for CSV export
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
230 action in Python 3. (Christof Meerwald)
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
231 - issue2551051: Return a 403 on non-existing or non-searchable
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
232 transitive properties when queried via REST-API (same behavior for
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
233 sorting and searching).
eb9d00db0923 Forgot to check in changed doc files for 2.0.0beta0
John Rouillard <rouilj@ieee.org>
parents: 5954
diff changeset
234 - Fixed ReStructuredText encoding with Python 3.
Roundup Issue Tracker: http://roundup-tracker.org/