Merge pull request #805 from MetRonnie/wrapper-script

Changelog for wrapper script fix
cylc · Feb 20, 2025 · fd4afbe · fd4afbe
2 parents 51433c0 + e9dadf8
commit fd4afbe
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/src/7-to-8/major-changes/ui.rst b/src/7-to-8/major-changes/ui.rst
@@ -67,13 +67,15 @@ As some workflows can be very large, or even infinite, the GUI uses a "window"
 system to determine what to display. For more information, see :ref:`n-window`.
 
 
+.. _Cylc Hub:
+
 Cylc Hub
 --------
 
 The Cylc 8 GUI can be deployed with Jupyter Hub to support multi-user access
 where it is possible to grant users the permission to view and interact with
-workflows running under other user accounts. In these deployments, users will
-have to authenticate when they open the GUI in the browser.
+workflows running under other user accounts. In these deployments, users
+authenticate when they open the GUI in the browser.
 
 The central server is started by the ``cylc hub`` command.
 

diff --git a/src/conf.py b/src/conf.py
@@ -166,7 +166,7 @@
 
 nitpick_ignore_regex = [
     # intersphinx has trouble with pyzmq classes:
-    ('py:class', 'zmq\.asyncio\.\w+')
+    ('py:class', r'zmq\.asyncio\.\w+')
 ]
 
 # -- Options for Slides output ----------------------------------------------

diff --git a/src/img/hub.png b/src/img/hub.png
diff --git a/src/reference/changes.rst b/src/reference/changes.rst
@@ -35,10 +35,27 @@ Cylc 8.4
    :cylc-rose: `1.5 <https://github.com/cylc/cylc-rose/blob/master/CHANGES.md>`__
    :rose: `2.4 <https://github.com/metomi/rose/blob/master/CHANGES.md>`__
 
+Wrapper script fix for Cylc Hub
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. versionadded:: cylc-flow 8.4.1
+
+Fixed wrapper script ``$PATH`` override preventing selection of Cylc version
+when playing workflows in the GUI on :ref:`Cylc Hub`.
+
+.. important::
+
+   Sites with existing wrapper scripts should update them with this change:
+   https://github.com/cylc/cylc-flow/pull/6616/files.
+
+.. seealso::
+
+   :ref:`managing environments`
+
 Cylc Remove
 ^^^^^^^^^^^
 
-Cylc Remove now allows removing tasks which are no longer active, making
+``cylc remove`` now allows removing tasks which are no longer active, making
 it look like they never ran. Removing a running task will now kill that task.
 
 The ``cylc remove`` command now has the ``--flow`` option, allowing removal