release: 4.0.0 (#1819)

* release: 4.0.0 * docs
dpgaspar · Mar 21, 2022 · a86835f · a86835f
1 parent 2e2931f
commit a86835f
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 48 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,12 @@
 Flask-AppBuilder ChangeLog
 ==========================
 
+Improvements and Bug fixes on 4.0.0
+-----------------------------------
+
+- chore: major bumps Flask, Click, PyJWT and flask-jwt-extended (#1817) [Daniel Vaz Gaspar]
+  [Breaking changes]
+
 Improvements and Bug fixes on 3.4.5
 -----------------------------------
 

diff --git a/README.rst b/README.rst
@@ -40,52 +40,6 @@ Change Log
 
 `Versions <https://github.com/dpgaspar/Flask-AppBuilder/tree/master/CHANGELOG.rst>`_ for further detail on what changed.
 
-BREAKING CHANGE on 3.0.0 (OAuth)
-
-Major version 3, changed it's **OAuth** dependency from flask-oauth to authlib, due to this OAuth configuration
-changed:
-
-Before:
-
-.. code-block::
-
-    OAUTH_PROVIDERS = [
-        {'name':'google', 'icon':'fa-google', 'token_key':'access_token',
-            'remote_app': {
-                'consumer_key':'GOOGLE KEY',
-                'consumer_secret':'GOOGLE SECRET',
-                'base_url':'https://www.googleapis.com/oauth2/v2/',
-                'request_token_params':{
-                  'scope': 'email profile'
-                },
-                'request_token_url':None,
-                'access_token_url':'https://accounts.google.com/o/oauth2/token',
-                'authorize_url':'https://accounts.google.com/o/oauth2/auth'}
-        }
-    ]
-
-Now:
-
-.. code-block::
-
-    OAUTH_PROVIDERS = [
-        {'name':'google', 'icon':'fa-google', 'token_key':'access_token',
-            'remote_app': {
-                'client_id':'GOOGLE KEY',
-                'client_secret':'GOOGLE SECRET',
-                'api_base_url':'https://www.googleapis.com/oauth2/v2/',
-                'client_kwargs':{
-                  'scope': 'email profile'
-                },
-                'request_token_url':None,
-                'access_token_url':'https://accounts.google.com/o/oauth2/token',
-                'authorize_url':'https://accounts.google.com/o/oauth2/auth'}
-        }
-    ]
-
-Also make sure you change your dependency for flask-oauth to `authlib <https://github.com/lepture/authlib>`_
-
-
 Fixes, Bugs and contributions
 -----------------------------
 

diff --git a/docs/breaking.rst b/docs/breaking.rst
@@ -0,0 +1,86 @@
+BREAKING CHANGES
+================
+
+Version 4.0.0
+-------------
+
+- Drops python 3.6 support
+- Removed config key `AUTH_STRICT_RESPONSE_CODES`, it's always strict now.
+- Removes `Flask-OpenID` dependency (you can install it has an extra dependency `pip install flask-appbuilder[openid]`)
+- Major version bumps on following packages
+
+**Flask from 1.X to 2.X**
+
+Breaking changes: https://flask.palletsprojects.com/en/2.0.x/changes/#version-2-0-0
+
+**flask-jwt-extended 3.X to 4.X:**
+
+Breaking changes: https://flask-jwt-extended.readthedocs.io/en/stable/v4_upgrade_guide/
+
+**Jinja2 2.X to 3.X**
+
+Breaking changes: https://jinja.palletsprojects.com/en/3.0.x/changes/#version-3-0-0
+
+**Werkzeug 1.X to 2.X**
+
+https://werkzeug.palletsprojects.com/en/2.0.x/changes/#version-2-0-0
+
+The following packages are probably not impactful to you:
+
+**pyJWT  1.X to 2.X:**
+
+Breaking changes: https://pyjwt.readthedocs.io/en/stable/changelog.html#v2-0-0
+
+**Click  7.X to 8.X:**
+
+Breaking changes:  https://click.palletsprojects.com/en/8.0.x/changes/#version-8-0-0
+
+**itsdangerous 1.X to 2.X**
+
+Breaking changes: https://github.com/pallets/itsdangerous/blob/main/CHANGES.rst#version-200
+
+Version 3.0.0 (OAuth)
+---------------------
+
+Major version 3, changed it's **OAuth** dependency from flask-oauth to authlib, due to this OAuth configuration
+changed:
+
+Before:
+
+.. code-block::
+
+    OAUTH_PROVIDERS = [
+        {'name':'google', 'icon':'fa-google', 'token_key':'access_token',
+            'remote_app': {
+                'consumer_key':'GOOGLE KEY',
+                'consumer_secret':'GOOGLE SECRET',
+                'base_url':'https://www.googleapis.com/oauth2/v2/',
+                'request_token_params':{
+                  'scope': 'email profile'
+                },
+                'request_token_url':None,
+                'access_token_url':'https://accounts.google.com/o/oauth2/token',
+                'authorize_url':'https://accounts.google.com/o/oauth2/auth'}
+        }
+    ]
+
+Now:
+
+.. code-block::
+
+    OAUTH_PROVIDERS = [
+        {'name':'google', 'icon':'fa-google', 'token_key':'access_token',
+            'remote_app': {
+                'client_id':'GOOGLE KEY',
+                'client_secret':'GOOGLE SECRET',
+                'api_base_url':'https://www.googleapis.com/oauth2/v2/',
+                'client_kwargs':{
+                  'scope': 'email profile'
+                },
+                'request_token_url':None,
+                'access_token_url':'https://accounts.google.com/o/oauth2/token',
+                'authorize_url':'https://accounts.google.com/o/oauth2/auth'}
+        }
+    ]
+
+Also make sure you change your dependency for flask-oauth to `authlib <https://github.com/lepture/authlib>`_
diff --git a/docs/index.rst b/docs/index.rst
@@ -70,7 +70,7 @@ Contents:
    diagrams
    api
    versionmigration
-
+   breaking
 
 Indices and tables
 ==================

diff --git a/flask_appbuilder/__init__.py b/flask_appbuilder/__init__.py
@@ -1,5 +1,5 @@
 __author__ = "Daniel Vaz Gaspar"
-__version__ = "3.4.5"
+__version__ = "4.0.0"
 
 from .actions import action  # noqa: F401
 from .api import ModelRestApi  # noqa: F401