Skip to content

Commit

Permalink
updated the changes guide
Browse files Browse the repository at this point in the history
  • Loading branch information
wxtim committed Jan 9, 2025
1 parent d7ccc0d commit 1f533a2
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
45 changes: 45 additions & 0 deletions src/reference/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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][<namespace>][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
Expand Down
5 changes: 5 additions & 0 deletions src/user-guide/interventions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------------------

Expand Down Expand Up @@ -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 <retry>` until released.

.. _interventions.skip_cycle:

I want to Skip a cycle of tasks and allow the workflow to continue
------------------------------------------------------------------
Expand Down Expand Up @@ -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
------------

Expand Down
4 changes: 4 additions & 0 deletions src/user-guide/task-implementation/skip-mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------

Expand Down Expand Up @@ -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
^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 1f533a2

Please sign in to comment.