Update release-notes, index.rst and upgrade-instructions for 1.8.0 re…

…lease
Grokzen · Dec 30, 2020 · 2846feb · 2846feb
1 parent f96eae7
commit 2846feb
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 10 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -88,7 +88,7 @@ Project details
    :target: https://coveralls.io/repos/github/Grokzen/pykwalify/badge.svg?branch=unstable
 
 +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| python support        | 3.6, 3.7                                                                                                                                                                                    |
+| python support        | 3.6, 3.7, 3.8, 3.9                                                                                                                                                                                              |
 +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Source                | https://github.com/Grokzen/pykwalify                                                                                                                                                                            |
 +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -132,9 +132,8 @@ Project details
 |                       |    $ pip install -e .                                                                                                                                                                                           |
 +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | required dependencies | | docopt >= 0.6.2                                                                                                                                                                                               |
-|                       | | python-dateutil >= 2.4.2                                                                                                                                                                                      |
-+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| supported yml parsers | ruamel.yaml >= 0.11.0                                                                                                                                                                                           |
+|                       | | ruamel.yaml >= 0.16.0                                                                                                                                                                                      |
+|                       | | python-dateutil >= 2.8.0                                                                                                                                                                                      |
 +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
@@ -4,19 +4,36 @@ Release Notes
 1.8.0 (Jan xx, 2021)
 --------------------
 
+General changes:
+
+- Dropped support for python 3.5 and below, including 2.7
 - ruamel.yaml is now the default and preffered yaml parser
-- Dropped support for pyyaml
+- Dropped support for pyyaml parser
+- Update minimum version of ruamel.yaml to 0.16.0
+- Update minimum version of python-dateutil to 2.8.0
+
+CLI changes:
+
 - Added new cli argument "--encoding ENCODING" that specifies what encoding to open data and schema files with
+
+Changed behaviour:
+
 - Enum error strings now output all possible values for easier debugging
+- Removed deprecated imp module. Dynamic imports imght be affected
+
+New features:
+
 - Implement new type email that uses a relative simple regex to validate email addresses according to RFC 5322 Official Standard
 - Implement new type `url` that uses a relative simple regex to validate url:s according to RFC 1808
-- Update minimum version of ruamel.yaml to 0.16.0
-- Update minimum version of python-dateutil to 2.8.0
-- Fixed a regression from 1.6.1 where ruamel.yaml safe_load would break for all built-in custom python tags.
-  All normal python tags should now be possible to use again.
 - Add new argument "schema_file_obj" to Core class. Allows to pass in StringIO or similar interfaced objects to use for validation.
 - Add new argument "data_file_obj" to Core class. Allows to pass in StringIO or similar interfaced objects to use for validation.
-- Deprecated imp module and removed support for python 3.5 and below.
+
+Bug/issues fixed:
+
+- Fixed a regression from 1.6.1 where ruamel.yaml safe_load would break for all built-in custom python tags.
+  All normal python tags should now be possible to use again.
+- Fixed an issue with regex values that was not converted to str() before regex mapping was attempted.
+  This should validate things like integers and objects that support str() conversion better.
 
 
 1.7.0 (October 3, 2018)

diff --git a/docs/upgrade-instructions.rst b/docs/upgrade-instructions.rst
@@ -10,6 +10,15 @@ If new types were added, they will not be described here because it will not bre
 
 Pyyaml was removed as supported and default installed yaml parser. The new default parser is ruamel.yaml. If you are running pyyaml then you need to uninstall it and install ruamel.yaml in order to continue to use this tool/library.
 
+Ruamel yaml is no longer available to be installed via the `extras_require=ruamel`
+
+Older python versions was dropped support for. This do not mean that they might work with older versions if you run them. But they will not be oficially published to pypi and supported if issues is found.
+
+Regex values will not be attempted to be converted with str() before validation is attempted. This can cause values that was previously validated or failed to now work or fail.
+
+Regex rules will now enforce a rule error if parentheses is missing in the regex defenition part.
+
+
 
 1.5.x --> 1.6.0
 ---------------