From 1f533a27bb5539fecd69561e12441196b5a62d0d Mon Sep 17 00:00:00 2001 From: Tim Pillinger Date: Thu, 9 Jan 2025 10:39:38 +0000 Subject: [PATCH] updated the changes guide --- src/reference/changes.rst | 45 +++++++++++++++++++ src/user-guide/interventions/index.rst | 5 +++ .../task-implementation/skip-mode.rst | 4 ++ 3 files changed, 54 insertions(+) diff --git a/src/reference/changes.rst b/src/reference/changes.rst index 4aae3fe243..15370ed370 100644 --- a/src/reference/changes.rst +++ b/src/reference/changes.rst @@ -38,13 +38,58 @@ Cylc 8.4 Cylc Remove ^^^^^^^^^^^ +Cylc Remove now allows removing tasks which are not 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 +of a task from specific flows. + +Tasks Removed from all flows are retained in the workflow database with +``flow=none`` for provenance. + +.. image:: ../user-guide/interventions/remove.gif + :width: 60% + +.. seealso:: + + See :ref:`interventions.remove_tasks` to see an example of this feature in + action. Skip Mode ^^^^^^^^^ +Tasks can be configured to run in skip mode, either from the configuration +or by broadcasting. + +.. image:: ../user-guide/interventions/skip-cycle.gui.gif + :width: 60% + +``cylc set --out skip`` will set outputs for a task as if the task has run +in skip mode. The task outputs delivered by skip mode can be customized using +:cylc:conf:`[runtime][][skip]outputs` or defaults to behaviour +described in :ref:`skip_mode.task_outputs`. + +This can be used to skip a cycle or a task (for a full example see + :ref:`interventions.skip_cycle`). + +It may also be useful for :ref:`EfficientInterFamilyTriggering` and +for :ref:`skip_mode.parameter_exclusion`. + +.. seealso:: + + :ref:`task-run-modes.skip` + Trigger When Paused ^^^^^^^^^^^^^^^^^^^ +Tasks can now be triggered and will run immediately while the workflow +is paused. + + +.. image:: ../user-guide/interventions/trigger-while-paused.gif + :width: 60% + +See :ref:`interventions.trigger_while_paused` for an example of this feature. EmPy Support Removed diff --git a/src/user-guide/interventions/index.rst b/src/user-guide/interventions/index.rst index c07366dced..3de007fe5d 100644 --- a/src/user-guide/interventions/index.rst +++ b/src/user-guide/interventions/index.rst @@ -441,6 +441,8 @@ but specify the "failed" output rather than "succeeded". +.. _interventions.trigger_while_paused: + Pause The Workflow And Trigger Tasks One By One ----------------------------------------------- @@ -489,6 +491,7 @@ Pause The Workflow And Trigger Tasks One By One submit) until released. If you hold a running task its job will not be affected, but it will not submit any :term:`retries ` until released. +.. _interventions.skip_cycle: I want to Skip a cycle of tasks and allow the workflow to continue ------------------------------------------------------------------ @@ -525,6 +528,8 @@ I want to Skip a cycle of tasks and allow the workflow to continue multiple named tasks. +.. _interventions.remove_tasks: + Remove Tasks ------------ diff --git a/src/user-guide/task-implementation/skip-mode.rst b/src/user-guide/task-implementation/skip-mode.rst index 328ca45932..35fb615162 100644 --- a/src/user-guide/task-implementation/skip-mode.rst +++ b/src/user-guide/task-implementation/skip-mode.rst @@ -29,6 +29,8 @@ Skip mode is designed as an aid to workflow control: If you are using skip mode deliberately then this can be ignored. +.. _skip_mode.task_outputs: + Task Outputs ------------ @@ -97,6 +99,8 @@ families improves the efficiency of the Cylc scheduler. This scenario is explained in detail in :ref:`EfficientInterFamilyTriggering` +.. _skip_mode.parameter_exclusion: + Parameter Exclusion ^^^^^^^^^^^^^^^^^^^