Bump version for release v0.20.0

globus · Nov 7, 2024 · 84734fa · 84734fa
1 parent db56156
commit 84734fa
Show file tree

Hide file tree

Showing 8 changed files with 69 additions and 55 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -10,6 +10,74 @@ Unreleased changes are documented in files in the `changelog.d`_ directory.
 
 ..  scriv-insert-here
 
+.. _changelog-0.20.0:
+
+0.20.0 — 2024-11-07
+===================
+
+Breaking changes
+----------------
+
+*   Remove the ``globus_action_provider_tools.flask.api_helpers`` module,
+    and the helpers it provided.
+
+    If possible, it is recommended to immediately migrate Action Providers
+    off of the code in the Flask API helpers module.
+
+    If this cannot be done immediately, it is recommended to pin
+    the Action Provider Tools dependency to ``0.19.1``.
+
+Deprecations
+------------
+
+*   The ``required_authorizer_expiration_time`` parameter to ``get_authorizer_for_scope`` is deprecated.
+
+    Given token expiration and caching lifetimes,
+    it was not possible for this parameter to have any effect based on its prior documented usage.
+
+Bugfixes
+--------
+
+*   Action Provider Tools no longer requests Dependent Refresh Tokens
+    if Access Tokens are sufficient. As a result of this fix,
+    the AuthState dependent token cache will never contain dependent refresh tokens.
+
+Changes
+-------
+
+*   ``AuthState.introspect_token()`` will no longer return ``None``
+    if the token is not active.
+
+    Instead, a new exception, ``InactiveTokenError``, will be raised.
+    ``InactiveTokenError`` is a subclass of ``ValueError``.
+
+    Code that calls ``AuthState.introspect_token()`` no longer returns ``None``, either,
+    but will instead raise ``ValueError`` (or a subclass) or a ``globus_sdk.GlobusAPIError``:
+
+    *   ``AuthState.get_authorizer_for_scope``
+    *   ``AuthState.effective_identity``
+    *   ``AuthState.identities``
+
+*   Group caching behavior in the ``AuthState`` class has been improved
+    to ensure that the cache is checked before any external operations
+    (e.g., dependent token callouts) are required.
+    The cache now uses the token hash as its key, rather than a dependent token.
+
+Documentation
+-------------
+
+*   Remove examples from documentation which relied upon the ``api_helpers`` module.
+
+Development
+-----------
+
+*   Introduce new scriv categories to better communicate how the project evolves.
+
+    The categories are also re-ordered,
+    which defines how fragments will be ordered in the CHANGELOG.
+
+*   Add a changelog fragment template.
+
 .. _changelog-0.19.1:
 
 0.19.1 — 2024-10-22

diff --git a/changelog.d/20241018_082221_kurtmckee_eliminate_none_return_values.rst b/changelog.d/20241018_082221_kurtmckee_eliminate_none_return_values.rst
diff --git a/changelog.d/20241025_172707_sirosen_improve_groups_caching.rst b/changelog.d/20241025_172707_sirosen_improve_groups_caching.rst
diff --git a/changelog.d/20241025_185333_sirosen_do_not_use_refresh_tokens.rst b/changelog.d/20241025_185333_sirosen_do_not_use_refresh_tokens.rst
diff --git a/changelog.d/20241030_100211_sirosen_remove_api_helpers.rst b/changelog.d/20241030_100211_sirosen_remove_api_helpers.rst
diff --git a/changelog.d/20241107_111041_kurtmckee_update_scriv_categories.rst b/changelog.d/20241107_111041_kurtmckee_update_scriv_categories.rst
diff --git a/changelog.d/20241107_122830_kurtmckee_update_scriv_categories.rst b/changelog.d/20241107_122830_kurtmckee_update_scriv_categories.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "globus-action-provider-tools"
-version = "0.19.1"
+version = "0.20.0"
 description = "Tools to help developers build services that implement the Action Provider specification."
 authors = [
     "Globus Team <[email protected]>",