Skip to content

Commit 1f533a2

Browse files
committed
updated the changes guide
1 parent d7ccc0d commit 1f533a2

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

src/reference/changes.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,58 @@ Cylc 8.4
3838
Cylc Remove
3939
^^^^^^^^^^^
4040

41+
Cylc Remove now allows removing tasks which are not longer active, making
42+
it look like they never ran. Removing a running task will now kill that task.
43+
44+
The ``cylc remove`` command now has the ``--flow`` option, allowing removal
45+
of a task from specific flows.
46+
47+
Tasks Removed from all flows are retained in the workflow database with
48+
``flow=none`` for provenance.
49+
50+
.. image:: ../user-guide/interventions/remove.gif
51+
:width: 60%
52+
53+
.. seealso::
54+
55+
See :ref:`interventions.remove_tasks` to see an example of this feature in
56+
action.
4157

4258
Skip Mode
4359
^^^^^^^^^
4460

61+
Tasks can be configured to run in skip mode, either from the configuration
62+
or by broadcasting.
63+
64+
.. image:: ../user-guide/interventions/skip-cycle.gui.gif
65+
:width: 60%
66+
67+
``cylc set --out skip`` will set outputs for a task as if the task has run
68+
in skip mode. The task outputs delivered by skip mode can be customized using
69+
:cylc:conf:`[runtime][<namespace>][skip]outputs` or defaults to behaviour
70+
described in :ref:`skip_mode.task_outputs`.
71+
72+
This can be used to skip a cycle or a task (for a full example see
73+
:ref:`interventions.skip_cycle`).
74+
75+
It may also be useful for :ref:`EfficientInterFamilyTriggering` and
76+
for :ref:`skip_mode.parameter_exclusion`.
77+
78+
.. seealso::
79+
80+
:ref:`task-run-modes.skip`
81+
4582
Trigger When Paused
4683
^^^^^^^^^^^^^^^^^^^
4784

85+
Tasks can now be triggered and will run immediately while the workflow
86+
is paused.
87+
88+
89+
.. image:: ../user-guide/interventions/trigger-while-paused.gif
90+
:width: 60%
91+
92+
See :ref:`interventions.trigger_while_paused` for an example of this feature.
4893

4994

5095
EmPy Support Removed

src/user-guide/interventions/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,8 @@ but specify the "failed" output rather than
441441
"succeeded".
442442

443443

444+
.. _interventions.trigger_while_paused:
445+
444446
Pause The Workflow And Trigger Tasks One By One
445447
-----------------------------------------------
446448

@@ -489,6 +491,7 @@ Pause The Workflow And Trigger Tasks One By One
489491
submit) until released. If you hold a running task its job will not be
490492
affected, but it will not submit any :term:`retries <retry>` until released.
491493

494+
.. _interventions.skip_cycle:
492495

493496
I want to Skip a cycle of tasks and allow the workflow to continue
494497
------------------------------------------------------------------
@@ -525,6 +528,8 @@ I want to Skip a cycle of tasks and allow the workflow to continue
525528
multiple named tasks.
526529

527530

531+
.. _interventions.remove_tasks:
532+
528533
Remove Tasks
529534
------------
530535

src/user-guide/task-implementation/skip-mode.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Skip mode is designed as an aid to workflow control:
2929
If you are using skip mode deliberately then this can be
3030
ignored.
3131

32+
.. _skip_mode.task_outputs:
33+
3234
Task Outputs
3335
------------
3436

@@ -97,6 +99,8 @@ families improves the efficiency of the Cylc scheduler.
9799
This scenario is explained in detail in
98100
:ref:`EfficientInterFamilyTriggering`
99101

102+
.. _skip_mode.parameter_exclusion:
103+
100104
Parameter Exclusion
101105
^^^^^^^^^^^^^^^^^^^
102106

0 commit comments

Comments
 (0)