Bump versions and collect changelog for release

globus · Nov 21, 2024 · 3e0f767 · 3e0f767
1 parent 69d0d72
commit 3e0f767
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 44 deletions.
diff --git a/changelog.d/20241023_095610_yadudoc1729_configure_tasks_working_dir.rst b/changelog.d/20241023_095610_yadudoc1729_configure_tasks_working_dir.rst
diff --git a/changelog.d/20241101_153924_chris_function_name_code.rst b/changelog.d/20241101_153924_chris_function_name_code.rst
diff --git a/changelog.d/20241101_155044_chris_function_description_from_docstring.rst b/changelog.d/20241101_155044_chris_function_description_from_docstring.rst
diff --git a/changelog.d/20241111_160525_chris_new_pythons.rst b/changelog.d/20241111_160525_chris_new_pythons.rst
diff --git a/changelog.d/20241114_143416_yadudoc1729_require_engine_start.rst b/changelog.d/20241114_143416_yadudoc1729_require_engine_start.rst
diff --git a/compute_endpoint/globus_compute_endpoint/version.py b/compute_endpoint/globus_compute_endpoint/version.py
@@ -1,6 +1,6 @@
 # single source of truth for package version,
 # see https://packaging.python.org/en/latest/single_source_version/
-__version__ = "2.31.0a1"
+__version__ = "2.31.0"
 
 # TODO: remove after a `globus-compute-sdk` release
 # this is needed because it's imported by `globus-compute-sdk` to do the version check

diff --git a/compute_endpoint/setup.py b/compute_endpoint/setup.py
@@ -6,7 +6,7 @@
 REQUIRES = [
     "requests>=2.31.0,<3",
     "globus-sdk",  # version will be bounded by `globus-compute-sdk`
-    "globus-compute-sdk==2.31.0a1",
+    "globus-compute-sdk==2.31.0",
     "globus-compute-common==0.5.0",
     "globus-identity-mapping==0.4.0",
     # table printing used in list-endpoints

diff --git a/compute_sdk/globus_compute_sdk/version.py b/compute_sdk/globus_compute_sdk/version.py
@@ -3,7 +3,7 @@
 
 # single source of truth for package version,
 # see https://packaging.python.org/en/latest/single_source_version/
-__version__ = "2.31.0a1"
+__version__ = "2.31.0"
 
 
 def compare_versions(

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -3,6 +3,48 @@ Changelog
 
 .. scriv-insert-here
 
+.. _changelog-2.31.0a1:
+
+globus-compute-sdk & globus-compute-endpoint v2.31.0a1
+------------------------------------------------------
+
+New Functionality
+^^^^^^^^^^^^^^^^^
+
+- ``GlobusComputeEngine``, ``ThreadPoolEngine``, and ``ProcessPoolEngine`` can
+  now be configured with ``working_dir`` to specify the tasks working directory.
+  If a relative path is specified, it is set in relation to the endpoint
+  run directory (usually ``~/.globus_compute/<endpoint_name>``). Here's an example
+  config file:
+
+  .. code-block:: yaml
+
+    engine:
+      type: GlobusComputeEngine
+      working_dir: /absolute/path/to/tasks_working_dir
+
+- Function docstrings are now read and used as the description for the function when it
+  is uploaded. This will support future UI changes to the webapp.
+
+- The ``globus-compute-sdk`` and ``globus-compute-endpoint`` packages now support
+  Python version 3.12.
+
+- Added a new runtime check to ``globus_compute_endpoint.engines`` that will raise a `RuntimeError`
+  if a task is submitted before ``engine.start()`` was called.
+
+Bug Fixes
+^^^^^^^^^
+
+ - Fixed a bug where functions run with ``ThreadPoolEngine`` and ``ProcessPoolEngine``
+   create and switch into the ``tasks_working_dir`` creating endless nesting.
+
+Deprecated
+^^^^^^^^^^
+
+- Before this version, the ``function_name`` argument to ``Client.register_function``
+  was not used, so it has now been deprecated. As before, function names are
+  determined by the function's ``__name__`` and cannot be manually specified.
+
 .. _changelog-2.30.1:
 
 globus-compute-sdk & globus-compute-endpoint v2.30.1