Skip to content

Commit 1c21e27

Browse files
authored
Merge pull request #791 from wxtim/major-changes
Update Major Changes Page
2 parents 63963c5 + 8dc2957 commit 1c21e27

File tree

4 files changed

+70
-1
lines changed

4 files changed

+70
-1
lines changed

src/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@
120120
# $ python -m sphinx.ext.intersphinx <url>/objects.inv | less
121121
intersphinx_mapping = {
122122
'rose': (
123-
'http://metomi.github.io/rose/2.3.0/html', None
123+
'http://metomi.github.io/rose/2.4.0/html', None
124124
),
125125
'python': (
126126
'https://docs.python.org/3/', None

src/reference/changes.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,66 @@ Cylc 8.4
3535
:cylc-rose: `1.5 <https://github.com/cylc/cylc-rose/blob/master/CHANGES.md>`__
3636
:rose: `2.4 <https://github.com/metomi/rose/blob/master/CHANGES.md>`__
3737

38+
Cylc Remove
39+
^^^^^^^^^^^
40+
41+
Cylc Remove now allows removing tasks which are no 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.
57+
58+
Skip Mode
59+
^^^^^^^^^
60+
61+
Tasks can now be run in "skip" mode where they complete
62+
their required outputs instantly.
63+
Tasks can be configured to run in skip mode either in the workflow configuration
64+
or by broadcasting.
65+
66+
.. image:: ../user-guide/interventions/skip-cycle.gui.gif
67+
:width: 60%
68+
69+
``cylc set --out skip`` will set outputs for a task as if the task has run
70+
in skip mode. The task outputs delivered by skip mode can be customized using
71+
:cylc:conf:`[runtime][<namespace>][skip]outputs` or defaults to behaviour
72+
described in :ref:`skip_mode.task_outputs`.
73+
74+
This can be used to skip a cycle or a task (for a full example see :ref:`interventions.skip_cycle`).
75+
76+
It may also be useful for :ref:`EfficientInterFamilyTriggering` and
77+
for :ref:`skip_mode.parameter_exclusion`.
78+
79+
.. seealso::
80+
81+
:ref:`task-run-modes.skip`
82+
83+
Trigger When Paused
84+
^^^^^^^^^^^^^^^^^^^
85+
86+
Tasks can now be triggered and will run immediately while the workflow
87+
is paused.
88+
89+
90+
.. image:: ../user-guide/interventions/trigger-while-paused.gif
91+
:width: 60%
92+
93+
.. seealso::
94+
95+
:ref:`interventions.trigger_while_paused` for an example of this feature.
96+
97+
3898
EmPy Support Removed
3999
^^^^^^^^^^^^^^^^^^^^
40100

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)