Bump version and changelog for release

globus · Mar 16, 2023 · 4423765 · 4423765
1 parent 1ab11f4
commit 4423765
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 25 deletions.
diff --git a/changelog.d/20230224_164805_sirosen_catch_empty_scopes.rst b/changelog.d/20230224_164805_sirosen_catch_empty_scopes.rst
diff --git a/changelog.d/20230301_174601_sirosen_improve_search_method_docs.rst b/changelog.d/20230301_174601_sirosen_improve_search_method_docs.rst
diff --git a/changelog.d/20230301_175502_sirosen_no_default_recursive.rst b/changelog.d/20230301_175502_sirosen_no_default_recursive.rst
diff --git a/changelog.d/20230302_202418_sirosen_fix_type_for_max_sleep.rst b/changelog.d/20230302_202418_sirosen_fix_type_for_max_sleep.rst
diff --git a/changelog.d/20230307_200009_sirosen_add_dependent_refresh_tokens_param.rst b/changelog.d/20230307_200009_sirosen_add_dependent_refresh_tokens_param.rst
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -12,6 +12,44 @@ to a major new version of the SDK.
 
 .. scriv-insert-here
 
+.. _changelog-3.18.0:
+
+v3.18.0 (2023-03-16)
+--------------------
+
+* When users input empty ``requested_scopes`` values, these are now rejected
+  with a usage error instead of being translated into the default set of
+  ``requested_scopes``
+
+* Behaviors which will change in version 4.0.0 of the ``globus-sdk`` now emit
+  deprecation warnings.
+
+* Omitting ``requested_scopes`` or specifying it as ``None`` is now deprecated
+  and will emit a warning. In version 4, users will always be required to
+  specify their scopes when performing login flows. This applies to the
+  following methods:
+
+  * ``ConfidentialAppAuthClient.oauth2_client_credentials_tokens``
+  * ``AuthClient.oauth2_start_flow``
+
+* ``SearchClient.update_entry`` and ``SearchClient.create_entry`` are
+  officially deprecated and will emit a warning. These APIs are aliases of
+  ``SearchClient.ingest``, but their existence has caused confusion. Users are
+  encouraged to switch to ``SearchClient.ingest`` instead (:pr:`695`)
+
+* ``TransferData.add_item`` now defaults to omitting ``recursive`` rather than
+  setting its value to ``False``. This change better matches new Transfer API
+  behaviors which treat the absence of the ``recursive`` flag as meaning
+  autodetect, rather than the previous default of ``False``. Setting the
+  recursive flag can still have beneficial behaviors, but should not be
+  necessary for many use-cases (:pr:`696`)
+
+* Fix the type annotation for `max_sleep` on client transports to allow `float`
+  values (:pr:`697`)
+
+* ``ConfidentialAppAuthClient.oauth2_get_dependent_tokens`` now supports the
+  ``refresh_tokens`` parameter to enable requests for dependent refresh tokens (:pr:`698`)
+
 .. _changelog-3.17.0:
 
 v3.17.0 (2023-02-27)

diff --git a/src/globus_sdk/version.py b/src/globus_sdk/version.py
@@ -1,3 +1,3 @@
 # single source of truth for package version,
 # see https://packaging.python.org/en/latest/single_source_version/
-__version__ = "3.17.0"
+__version__ = "3.18.0"