Mercurial > p > roundup > code

comparison doc/upgrading.txt @ 5941:29d428927362

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
prep for 2.0.0alpha0 release. Initial set of changes for the release. Still a few files to change.
author John Rouillard <rouilj@ieee.org>
date Tue, 22 Oct 2019 14:30:52 -0400
parents 9938c40e03bc
children d7e6bcde5cbe
comparison
equal deleted inserted replaced
5940:459426a8c61e 5941:29d428927362
18 Contents: 18 Contents:
19 19
20 .. contents:: 20 .. contents::
21 :local: 21 :local:
22 22
23 Migrating from 1.6.0 to x.y.0 23 Migrating from 1.6.X to 2.0.0
24 ============================= 24 =============================
25 25
26 Upgrade tracker's config.ini file 26 Upgrade tracker's config.ini file
27 -------------------------------------- 27 --------------------------------------
28 Once you have installed the new roundup, use: 28 Once you have installed the new roundup, use:
31 31
32 to generate a new ini file preserving all your settings. You can then 32 to generate a new ini file preserving all your settings. You can then
33 merge any local comments from the tracker's ``config.ini`` into 33 merge any local comments from the tracker's ``config.ini`` into
34 ``new_init_file.ini``. Compare the old and new files and configure set 34 ``new_init_file.ini``. Compare the old and new files and configure set
35 any new settings as you want. Then replace ``config.ini`` with the new 35 any new settings as you want. Then replace ``config.ini`` with the new
36 init file. 36 ini file.
37
38 PGP mail processing
39 -------------------
40
41 Roundup now uses the ``gpg`` module instead of ``pyme`` to process PGP
42 mail. If you have PGP processing enabled, make sure the ``gpg``
43 module is installed.
44
45 MySQL client module
46 -------------------
47
48 Although the ``MySQLdb`` module from
49 https://pypi.org/project/MySQL-python/ is still supported, it is
50 recommended to switch to the updated module from
51 https://pypi.org/project/mysqlclient/.
52
53 XMLRPC Access Role
54 ------------------
55
56 A new permission has been added to control access to the XMLRPC
57 endpoint. If the user doesn't have the new "Xmlrpc Access" permission,
58 they will not be able to log in using the /xmlrpc end point. To add
59 this new permission to the "User" role you should change your
60 tracker's schema.py and add::
61
62 db.security.addPermissionToRole('User', 'Xmlrpc Access')
63
64 This is usually included near where other permissions like "Web Access"
65 or "Email Access" are assigned.
66
67 New values for db.tx_Source
68 ---------------------------
69
70 The database attribute tx_Source reports "xmlrpc" and "rest" when the
71 /xmlrpc and /rest web endpoints are used. Check all code (extensions,
72 detectors, lib) in trackers looking for tx_Source. If you have code
73 like::
74
75 if db.tx_Source == "web":
76
77 or::
78
79 if db.tx_Source in ['web', 'email-sig-openpgp', 'cli' ]:
80
81 you may need to change these to include matches to "rest" and
82 "xmlrpc". For example::
83
84 if db.tx_Source in [ "web", "rest", "xmlrpc" ]
85
86 or::
87
88 if db.tx_Source in ['web', 'rest', 'xmlrpc', 'email-sig-openpgp', 'cli' ]:
89
90 37
91 Python 3 support 38 Python 3 support
92 ---------------- 39 ----------------
93 40
94 Many of the ``.html`` and ``.py`` files from Roundup that are copied 41 Many of the ``.html`` and ``.py`` files from Roundup that are copied
108 with a leading ``0`` (``022``). They now use a leading ``0o`` 55 with a leading ``0`` (``022``). They now use a leading ``0o``
109 (``0o22``). Note that the ``0o`` format is properly handled under 56 (``0o22``). Note that the ``0o`` format is properly handled under
110 python 2. You can use the ``newfile.ini`` generated using 57 python 2. You can use the ``newfile.ini`` generated using
111 ``python3 roundup-admin ... updateconfig newfile.ini`` 58 ``python3 roundup-admin ... updateconfig newfile.ini``
112 if you want to go back to using python 2. 59 if you want to go back to using python 2.
60
61 PGP mail processing
62 -------------------
63
64 Roundup now uses the ``gpg`` module instead of ``pyme`` to process PGP
65 mail. If you have PGP processing enabled, make sure the ``gpg``
66 module is installed.
67
68 MySQL client module
69 -------------------
70
71 Although the ``MySQLdb`` module from
72 https://pypi.org/project/MySQL-python/ is still supported, it is
73 recommended to switch to the updated module from
74 https://pypi.org/project/mysqlclient/.
75
76 XMLRPC Access Role
77 ------------------
78
79 A new permission has been added to control access to the XMLRPC
80 endpoint. If the user doesn't have the new "Xmlrpc Access" permission,
81 they will not be able to log in using the /xmlrpc end point. To add
82 this new permission to the "User" role you should change your
83 tracker's schema.py and add::
84
85 db.security.addPermissionToRole('User', 'Xmlrpc Access')
86
87 This is usually included near where other permissions like "Web Access"
88 or "Email Access" are assigned.
89
90 New values for db.tx_Source
91 ---------------------------
92
93 The database attribute tx_Source reports "xmlrpc" and "rest" when the
94 /xmlrpc and /rest web endpoints are used. Check all code (extensions,
95 detectors, lib) in trackers looking for tx_Source. If you have code
96 like::
97
98 if db.tx_Source == "web":
99
100 or::
101
102 if db.tx_Source in ['web', 'email-sig-openpgp', 'cli' ]:
103
104 you may need to change these to include matches to "rest" and
105 "xmlrpc". For example::
106
107 if db.tx_Source in [ "web", "rest", "xmlrpc" ]
108
109 or::
110
111 if db.tx_Source in ['web', 'rest', 'xmlrpc', 'email-sig-openpgp', 'cli' ]:
112
113 113
114 Migrating from 1.5.1 to 1.6.0 114 Migrating from 1.5.1 to 1.6.0
115 ============================= 115 =============================
116 116
117 Update tracker config file 117 Update tracker config file
Roundup Issue Tracker: http://roundup-tracker.org/