Skip to content

Commit f272a06

Browse files
change: add completion expression entry
1 parent afa6d9e commit f272a06

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

src/reference/changes.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,41 @@ The graph view now has an option to group tasks by cycle point.
132132
.. image:: changes/cylc-graph-group-by-cycle-point.png
133133
:width: 100%
134134

135+
136+
Completion Expressions
137+
^^^^^^^^^^^^^^^^^^^^^^
138+
139+
When a task finishes, its outputs are validated against a "completion
140+
expression" to ensure that it has produced all of its
141+
:term:`required outputs <required output>`.
142+
If a task fails this validation check it is said to have "incomplete outputs"
143+
and will be retained in the :term:`active window` pending user intervention.
144+
145+
This completion expression is generated automatically from the graph.
146+
By default, tasks are expected to succeed, if you register any additional
147+
required output in the graph, then these must also
148+
be produced.
149+
150+
At Cylc 8.3.0 it is now possible to manually configure this completion
151+
expression for finer control. This is particularly useful for anyone using
152+
:term:`custom outputs <custom output>`.
153+
154+
For example, ``mytask`` must produce one of the outputs ``x`` or ``y`` to pass
155+
the configured completion expression configured here:
156+
157+
.. code-block:: cylc
158+
159+
[runtime]
160+
[[mytask]]
161+
completion = succeeded and (x or y)
162+
[[[outputs]]]
163+
x = output-x
164+
y = output-y
165+
166+
For more information, see the reference for the
167+
:cylc:conf:`[runtime][<namespace>]completion` configuration.
168+
169+
135170
----------
136171

137172
Cylc 8.2

0 commit comments

Comments
 (0)