Skip to content

document 7209 - removal of graph orphans on reload/restart - #973

Open
oliver-sanders wants to merge 3 commits into
cylc:masterfrom
oliver-sanders:poor-things
Open

oliver-sanders wants to merge 3 commits into
cylc:masterfrom
oliver-sanders:poor-things

Conversation

@oliver-sanders

@oliver-sanders oliver-sanders commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

document cylc/cylc-flow#7209

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

@oliver-sanders oliver-sanders added this to the 8.7.x milestone Sep 29, 2026
@oliver-sanders oliver-sanders self-assigned this Sep 29, 2026
@oliver-sanders oliver-sanders added the content Addition or modification of documentation label Sep 29, 2026
Comment thread src/reference/changes.rst Outdated
Co-authored-by: Oliver Sanders <oliver.sanders@metoffice.gov.uk>
Comment on lines -150 to -152
If dependencies have changed, tasks that were already active will spawn
children according to their original outputs. Subsequent instances will have
the new settings.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think this has been wrong for a while now.

@MetRonnie MetRonnie changed the title document https://github.com/cylc/cylc-flow/pull/7209 document 7209 - removal of graph orphans on reload/restart Oct 1, 2026

@hjoliver hjoliver left a comment

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.

Good, just suggested some minor edits for grammar and conciseness.

Comment thread src/reference/changes.rst Outdated
Comment thread src/user-guide/running-workflows/scheduler-start-up.rst Outdated
Comment thread src/user-guide/running-workflows/scheduler-start-up.rst Outdated
Comment thread src/user-guide/running-workflows/scheduler-start-up.rst Outdated
Comment thread src/user-guide/running-workflows/scheduler-start-up.rst Outdated
Comment thread src/user-guide/running-workflows/scheduler-start-up.rst Outdated
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
Comment thread src/reference/changes.rst
Comment on lines +36 to +39
Active instances of tasks removed from the
:term:`graph` by restart or reload will now be removed from the workflow
(i.e, ``cylc remove``). If they have active jobs, they will be
killed.

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.

I would be tempted to align more closely to my suggested changelog entry for the cylc-flow PR

Suggested change
Active instances of tasks removed from the
:term:`graph` by restart or reload will now be removed from the workflow
(i.e, ``cylc remove``). If they have active jobs, they will be
killed.
When you delete tasks from the :term:`graph` and then reinstall and
reload/restart the workflow, Cylc will now kill and remove any active instances
of those tasks (as ``cylc remove`` would do).

@hjoliver hjoliver Oct 4, 2026 •

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.

The current phrasing is partly my fault, but as it happens I was also considering whether "removed by reload or restart" is potentially confusing.
My variant of this tweak:

Suggested change
Active instances of tasks removed from the
:term:`graph` by restart or reload will now be removed from the workflow
(i.e, ``cylc remove``). If they have active jobs, they will be
killed.
If you remove tasks from the :term:`graph`, any active instances of those tasks
will be killed and removed from the workflow when you reload or restart.

Comment on lines +165 to +167
Active instances of tasks removed from the
graph will be removed (by ``cylc remove``) from the workflow.
Their active jobs, if they have any, will be killed.

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
Active instances of tasks removed from the
graph will be removed (by ``cylc remove``) from the workflow.
Their active jobs, if they have any, will be killed.
Active instances of tasks removed from the
graph will be removed from the workflow (just like if you called
``cylc remove`` on them).
Their active jobs, if they have any, will be killed.

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.

Could be phrased as in the change log, now (e.g. "My variant of this tweak:" above).

@oliver-sanders oliver-sanders Oct 6, 2026 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

(raise a suggestion if you want it changed differently)

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.

Ok:

Suggested change
Active instances of tasks removed from the
graph will be removed (by ``cylc remove``) from the workflow.
Their active jobs, if they have any, will be killed.
If you remove tasks from the :term:`graph`, any active instances of those tasks
will be killed and removed from the workflow when you reload or restart.

Comment on lines +158 to +159
:term:`Parentless` tasks will not be inserted into the workflow automatically
as there is no upstream task to spawn them, so must be inserted manually.

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.

Tempted to avoid the term "insert" so as not to encourage long-standing Cylc 7 users to keep outdated mental model in their heads!

Suggested change
:term:`Parentless` tasks will not be inserted into the workflow automatically
as there is no upstream task to spawn them, so must be inserted manually.
:term:`Parentless` tasks will not appear in the workflow automatically
as there is no upstream task to spawn them, so must be dealt with manually.

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.

Agreed.

Active instances of tasks removed from the
graph will be removed (by ``cylc remove``) from the workflow.
Their active jobs, if they have any, will be killed.

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.

Ooh, might be good to note this?

Suggested change
.. note::
Cylc cannot track when you rename a task; it will consider the change
as removal of one task and addition of another.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Addition or modification of documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants