Skip to content

expiry: clarify late expiry events #7505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oliver-sanders wants to merge 1 commit into
base: master
Choose a base branch
from
Open

expiry: clarify late expiry events #7505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions cylc/flow/etc/examples/expiry/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,18 @@ more quickly.

.. literalinclude:: three/flow.cylc
:language: cylc


Note: Expiry Events
^^^^^^^^^^^^^^^^^^^

Expiry is a mechanism for "cancelling" tasks *before* they run.

Expiry is only detected for :term:`active` tasks in the waiting state.

This means that if a task ahead of the workflow passes its expiry time, this
event will not be detected until the workflow catches up with it.

If you need something in your workflow to happen at a configured time, use
:term:`clock triggers <clock trigger>` rather than triggering off of the
``:expired`` output.
Comment on lines +91 to +94

@hjoliver hjoliver Oct 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you need something in your workflow to happen at a configured time, use
:term:`clock triggers <clock trigger>` rather than triggering off of the
``:expired`` output.

I'd suggest not putting this here, unless you have evidence that users try to use expiry for this purpose? Triggering off of an expiry event seems an odd way to attempt anything other than respond to the expiry itself (i.e. "this task expired, it's not going to run, so do this instead").

Besides, clock triggers actually have a similar "lateness" problem to expiry - they aren't checked until the dependent task enters the active window, so clock triggers make things happen after, not at, a configured time.

Loading