merge heads

Author: rouilj

.hgtags

@@ -136,3 +136,8 @@ ff92cc5d9359ee6c83e1a8338b363a9aa421d64c 2.0.0beta0
 013a2e3da452a5dcc05e15f4a03667a8d4bc0870 2.1.0b1
 cbc18a8bc61f120fc27df2a90d7c922b12bf9014 2.1.0
 b3ba03d2b214ce598d3a181f3b43b46c3406713f 2.2.0b1
+c90104abe508e3886917243e4acd069c8ef7a1a4 2.2.0
+c90104abe508e3886917243e4acd069c8ef7a1a4 2.2.0
+0000000000000000000000000000000000000000 2.2.0
+0000000000000000000000000000000000000000 2.2.0
+239d9542b02062c56f88fd1de8b87c4d88d700ad 2.2.0

CHANGES.txt

@@ -12,7 +12,7 @@ v2.7.2 or later are required to run newer releases of Roundup.
 Roundup 2.0 supports Python 3.4 and later. Roundup 2.1.0 supports
 python 3.6 or newer (3.4/3.5 might work, but they are not tested).
 
-2022-yy-zz 2.2.0
+2022-07-13 2.2.0
 
 Fixed:
 

RELEASE.txt

@@ -26,7 +26,7 @@ Roundup release checklist:
         python2 -m pytest test/
 
 3.  Update version in:
-      CHANGES.txt
+      CHANGES.txt (set date for version as well) 
       roundup/__init__.py
       website/www/index.txt
       website/www/conf.py  (also update copyright)
@@ -84,7 +84,7 @@ Roundup release checklist:
     (if you find sdist a little verbose, add "--quiet" to the end of the
      command)
 9a. 2021/04/17 skip this for now. Need to make sure that whl installs
-    exectuable scripts properly and update these directions to test.
+    executable scripts properly and update these directions to test.
 
        python2 setup.py bdist_wheel; python3 setup.py bdist_wheel
 
@@ -123,11 +123,12 @@ Roundup release checklist:
     with all available Python versions.
 11a. (TBD how to test wheel binary distribution before uploading.)
 
-12. Assuming all is well tag the release in the version-control
+12. Assuming all is well commit and tag the release in the version-control
     system.
-      a) hg tag 1.6.0  # use right version. Should create/commit a changeset
-      b) hg push       # update main repo
-      c) hg sum        # verify that the tag shows up
+      a) hg commit ... # commit any edits from steps 1-5
+      b) hg tag 2.1.0  # use right version. Should create/commit a changeset
+      c) hg push       # update main repo
+      d) hg sum        # verify that the tag shows up
 
 13. Upload source distribution to PyPI - requires you sign up for a
     pypi account and be added as a maintainer to roundup. Ask existing
@@ -168,23 +169,26 @@ Roundup release checklist:
     distributions (if created). Follow the directions for generating
     the gpg asc files and upload the .whl distribution and .whl.asc
     signature files together.
+
 14. Refresh website.
       website/README.txt
       https://www.roundup-tracker.org/ should state that the stable
       version is the one that you released.
       https://www.roundup-tracker.org/docs.html should also match the
       released version (or at least the major non pre-release
       1.x/2.x version).
-16. Send doc/announcement.txt to [email protected],
+
+15. Send doc/announcement.txt to [email protected],
     [email protected],
     [email protected], and [email protected].
-16b. Update entry on https://freshcode.club/projects/roundup-tracker
-16c. Update entries for fossies by emailing announcement to
+15b. Update entry on https://freshcode.club/projects/roundup-tracker
+15c. Update entries for fossies by emailing announcement to
      [email protected]
-16d. Update entry on https://directory.fsf.org/wiki/Roundup.
-17. Change the release version on the GitHub section at
+15d. Update entry on https://directory.fsf.org/wiki/Roundup.
+
+16. Change the release version on the GitHub section at
     https://wiki.roundup-tracker.org/CiTestingEnvironment
-17b. Update release info on wikipedia:
+16b. Update release info on wikipedia:
      https://en.wikipedia.org/wiki/Roundup_(issue_tracker)
 
      https://en.wikipedia.org/wiki/Comparison_of_issue-tracking_systems

doc/acknowledgements.txt

@@ -13,28 +13,28 @@ ideas and everything else that helped!
 2.2
 ---
 
-2.2.0b1
-~~~~~~~
+2.2.0
+~~~~~
 
 Maintainer:  John Rouillard, Ralf Schlatterbeck
 
 Release Manager: John Rouillard
 
 Developer activity by changesets::
 
-  [email protected]         224  ************************************************
+  [email protected]         291 ************************************************
   [email protected]           11 **
   aburke                    1
   [email protected]         1
   [email protected]      1
 
 Other contributers
 
-Marcus Priesch
-John Kristensen (jerrykan)
-Ashely Burke
-Nagy Gabor
-Norbert Schlemmer
+Marcus Priesch,
+John Kristensen (jerrykan),
+Ashely Burke,
+Nagy Gabor,
+Norbert Schlemmer,
 Thomas Arendsen Hein
 
 2.1
@@ -113,7 +113,7 @@ Other contributers
 
 Chau Nguyen,
 Andreas (anrounham14),
-Robert Klonner
+Robert Klonner,
 Garth Jensen
 
 1.6

doc/admin_guide.txt

@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         How to administer, backup, upgrade a Roundup installation.
         System and user security, configuring web compression,
         documentation on using roundup-server and running
@@ -556,8 +556,10 @@ it to be elsewhere) will then complete the backup.
 Software Upgrade
 ----------------
 
-Always make a backup of your tracker before upgrading software. Steps you may
-take:
+.. _make a backup: #tracker-backup
+
+Always `make a backup`_ of your tracker before upgrading software.
+Steps you may take:
 
 1. Install pytest and ensure that the unit tests run on your system
    (using your preferred python version)::
@@ -576,11 +578,11 @@ take:
 
     python setup.py install
 
-6. Follow the steps in the `upgrading documentation`_ for the new version of
-   the software in the copied.
+6. Follow the steps in the `upgrading documentation`_ for all the
+   version between your original version and th new version.
 
-   Usually you will be asked to run `roundup_admin migrate` on your tracker
-   before you allow users to start accessing the tracker.
+   Usually you should run `roundup_admin -i <tracker_home> migrate`
+   on your tracker(s) before you allow users to start accessing the tracker.
 
    It's safe to run this even if it's not required, so just get into the
    habit.
@@ -591,7 +593,6 @@ reinstall the older version of the sofware using the same install command::
 
     python setup.py install
 
-
 .. index:: database; convert from one database backend to another
    single: roundup-admin; import and export
 

doc/announcement.txt

@@ -1,78 +1,68 @@
-I'm proud to release version 2.2.0b1 of the Roundup issue tracker.
-This release is a bugfix and minor feature
+I'm proud to release version 2.2.0 of the Roundup issue
+tracker.  This release is a bugfix and minor feature
 release, so make sure to read `docs/upgrading.txt
-<https://www.roundup-tracker.org/docs/upgrading.html>`_ to bring your
-tracker up to date.
+<https://www.roundup-tracker.org/docs/upgrading.html>`_ to
+bring your tracker up to date.
 
-The changes, as usual, include some new features and many bug fixes.
+The changes, as usual, include some new features and many
+bug fixes.
 
-Note that you should run ``roundup-admin ... migrate`` to update the
-database schema version. Do this before you use the web, command-line
-or mail interface and before any users access the tracker.  
+Note that you should run ``roundup-admin ... migrate`` to
+update the database schema version. Do this before you use
+the web, command-line or mail interface and before any users
+access the tracker.
 
-You can download it with:
+You can download it with::
 
    pip download roundup
 
-then unpack and test/install the tarball.
+then unpack and test/install the tarball. Also::
+
+   pip install roundup
+
+(preferably in a virtual environment) can be used.
 
 Among the notable improvements from the 2.1.0 release are:
 
-- Roundup supports dynamic and static compression of http
-  responses.
+- Dynamic and static compression of http responses. This
+  improves performance when a front end web server isn't
+  serving compressed assets.
+  
+- REST interface supports CORS allowing Roundup to be used
+  by third party web sites. Can specify origins allowed to
+  use the REST interface. OpenAPI (SWagger) docs can be
+  added. Error handling/reporting improved.
 
-- Better support for range headers and HTTP 1.1 in
-  roundup-server.
+- Dockerfile to build a containerized Roundup instance.  A
+  docker-compose configuration to deploy a a mysql based
+  tracker is also supplied.
 
 - New full text search methods. SQLite FTS and PostgreSQL
   full text search are supported. These allow search
-  expressions in addition to simple word based
-  searches.
-
-- Word size for Roundup's full text search increased to 50.
-
-- CORS support for the REST interface allowing Roundup to
-  be used by third party services. Includes ability to
-  list valid Origins in CSRF checks.
-
-- Dockerfile support. Docker-compose for a mysql based
-  tracker.
+  expressions in addition to simple word based searches.
 
 - Secret values in config.ini can be stored in external
   files. This allows config.ini to be stored in a VCS
   without exposing secrets.
 
-- Improvements to REST: fix crashes, support JWT in url,
-  dynamic endpoint list, OpenAPI (Swagger) doc can be specified,
-  allowed methods reported on error.
-
-- Define default cache times for js and css assets.
+- Translation object added to internal database handle. This
+  allows auditors and extensions to provide efficient
+  translations.
 
-- Login with empty passwords is disabled by default.
+- MySQL database creation uses COLLATE utf8_general_ci
 
-- ETag value changes depending on content-encoding.
+- Wsgi startup improvements (must be enabled by setting
+  feature flag).
 
 - Fix crash when importing legacy Roundup tracker with long
   integers.
 
-- Workaround lock contention by adding jitter to access of
-  one time key and sessions anydbm databases.
-
-- Fixes for deprecated calls/libraries in newer Pythons:
-  distutils, crypt, socket.sslserver....
-
-- Additional strings marked for translation.
-
-- Multiple crash fixes.
-
-- Improvements to tracker templates.
-
-- Translation object added to internal database
-  handle. This allows auditors and extensions to
-  provide efficient translations.
+- Fix issues with Roundup unable to find supporting files
+  when installed via pip. Removed additional references to
+  distfiles module.
 
 The file CHANGES.txt has a detailed list of feature additions and
-bug fixes (50) for each release. The most recent changes from
+bug fixes (57) for each release. The most recent changes from
 there are at the end of this announcement. Also see the
 information in doc/upgrading.txt.
 
@@ -88,9 +78,10 @@ If you're upgrading from an older version of Roundup you *must* follow
 all the "Software Upgrade" guidelines given in the doc/upgrading.txt
 documentation.
 
-Note that you should run ``roundup-admin ... migrate`` to update the
-database schema version. Do this before you use the web, command-line
-or mail interface and before any users access the tracker.  
+Note that you should run ``roundup-admin ... migrate`` for
+all your trackers to update the database schema version. Do
+this before you use the web, command-line or mail interface
+and before any users access the tracker.
 
 Roundup requires Python 2 newer than version 2.7.2 or Python 3 newer
 than or equal to version 3.6 for correct operation. (Python
@@ -150,9 +141,10 @@ and supports four database back-ends (anydbm, sqlite, mysql and postgresql).
 Recent Changes
 ==============
 
-From 2.1.0 to 2.2.0b1.
+From 2.1.0 to 2.2.0.
 
 Fixed:
+------
 
 - issue2551161 - Fix ResourceWarnings when running with -W default.
   Cleaned up leaking file descriptors from zopetal pre-compile, python
@@ -174,6 +166,8 @@ Fixed:
   length. All other paths with a . in then will be passed through
   without change. This allows items like a JWT to be passed as a path
   element. (John Rouillard)
+- issue2550995 - KeyError classic during roundup-admin install. Add
+  paths to search for locale and template files.
 - issue2551167 - pip install in containerized environments puts
   template and locale files under site-packages where roundup can't find
   them. Change code to find them under site-packages.
@@ -239,9 +233,21 @@ Fixed:
 - issue2551207 - Fix sorting by order attribute if order attributes can
   be None. Add a test.
 - issue2551203 fix CORS requests by providing proper headers and allowing
-  unauthenticted CORS preflight requests.
+  unauthenticted CORS preflight requests. (Marcus Priesch and John
+  Rouillard)
+- issue2551206 - removed some windows installer references that were missed.
+- document use of jinja2 templating as optional in config.ini
+  file. Report if available or not. (John Rouillard)
+- make setup.py install the Zope and wsgi.py frontends under
+  share/frontends. This matches the install of the cgi-bin/roundup.cgi
+  frontend. (John Rouillard)
+- prevent submit button from showing up when using _generic.item.html
+  if the user doesn't have edit permissions. (John Rouillard)
+- issue2551216 - create new mysql databases using COLLATE
+  utf8_general_ci to prevent crashes in test suite. (John Rouillard)
 
 Features:
+---------
 
 - issue2551147 - Enable compression of http responses in roundup.
   Allow roundup to return gzip, (br or zstd with added modules)
@@ -306,3 +312,6 @@ Features:
   i18n object is now also correctly set for the mail interface:
   previously the 'language' setting in the [mailgw] section seems to
   have been ignored. Thanks to Marcus Priesch for the patch.
+- issue2551212 - speed up wsgi interface by caching the tracker
+  instance. Hidden behind a feature flag. See upgrading.txt for
+  details. (Marcus Priesch with feature flag by John Rouillard)

doc/customizing.txt

@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         How to customize and extend the Roundup Issue
         Tracker. Includes many cookbook and how-to
         examples. Reference for the design and internals

doc/features.txt

@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Features of using the Roundup Issue Tracker. Describes
         all access methods, configuration and workflow capabilities.
 	Links to detailed documentation.

doc/glossary.txt

@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Definitions of terms used in the Roundup Issue Tracker
 	documentation.
 

doc/html_extra/spec.html

@@ -1,5 +1,7 @@
 <html>
 <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1">
 <title>Software Carpentry Track: Roundup</title>
 </head>
 <body bgcolor=white>