Skip to content

Commit 591e451

Browse files
changes: broadcast expiry
1 parent b97a1e5 commit 591e451

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

src/reference/changes.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,43 @@ Supported Python versions
131131
The minimum supported Python version is now 3.12.
132132

133133

134+
Automatic Broadcast Expiry
135+
^^^^^^^^^^^^^^^^^^^^^^^^^^
136+
137+
Broadcasts automatically expire (i.e, are deleted) once they are no longer
138+
required by upcoming tasks.
139+
140+
This means that if you try to re-run a task from the previous cycle, its
141+
broadcasts will likely have been expired. In Cylc 8.6.0, we have pushed back
142+
the broadcast expiry limit to make it easier to re-run tasks from the previous
143+
cycle. For more information, see
144+
:ref:`the user guide <user_guide.broadcast.expiry>`.
145+
146+
Another consequence of broadcast expiry is that broadcasts made to historical
147+
cycles (behind the broadcast expiry point) will expire instantly.
148+
The ``cylc trigger --on-resume`` option was added to allow us to broadcast to
149+
a cycle before triggering the task:
150+
151+
* Pause the workflow.
152+
* Trigger the task using the ``--on-resume`` option
153+
(the task will not run until the workflow is resumed).
154+
* Issue the broadcast.
155+
* Resume the workflow (the task will now run).
156+
157+
At Cylc 8.6.0, automatic broadcast expiry is suspended while the workflow is
158+
paused which simplifies this process:
159+
160+
* Pause the workflow.
161+
* Issue the broadcast.
162+
* Trigger the task (no special option required).
163+
* Resume the workflow.
164+
165+
Note the order of the broadcast and trigger operations has swapped to the
166+
logical order.
167+
168+
The ``--on-resume`` option has been removed.
169+
170+
134171
----------
135172

136173
Cylc 8.5

0 commit comments

Comments
 (0)