Skip to content

Commit

Permalink
Merge pull request #791 from wxtim/major-changes
Browse files Browse the repository at this point in the history
Update Major Changes Page
  • Loading branch information
wxtim authored Jan 9, 2025
2 parents 63963c5 + 8dc2957 commit 1c21e27
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
# $ python -m sphinx.ext.intersphinx <url>/objects.inv | less
intersphinx_mapping = {
'rose': (
'http://metomi.github.io/rose/2.3.0/html', None
'http://metomi.github.io/rose/2.4.0/html', None
),
'python': (
'https://docs.python.org/3/', None
Expand Down
60 changes: 60 additions & 0 deletions src/reference/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,66 @@ 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>`__

Cylc Remove
^^^^^^^^^^^

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
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 now be run in "skip" mode where they complete
their required outputs instantly.
Tasks can be configured to run in skip mode either in the workflow 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%

.. seealso::

: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 1c21e27

Please sign in to comment.