Skip to content
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.

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

example: extending workflow #6223

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

oliver-sanders
Copy link
Member

Important

This is #5947 with the "complex" example (to which we do not currently have a generic solution) chopped of. The remainder of that PR will need to wait, however there is pressure for us to get the simple bit documented now.

Document the preferred approach to "extending" a workflow.

Partially addresses: cylc/cylc-doc#525
Partially addresses: #5875

Context:

A common pattern in some areas is to run a workflow until it stops. Then modify the final cycle point to extend the workflow and restart.

This isn't an easy working pattern to port to Cylc 8 due to the difficulty of re-populating the start tasks. We have a plan to make this easier, see #5416, however, this working pattern is needlessly complex in the first place. It would be much simpler if the workflow didn't "finish" in the first place.

To do this, swap final cycle point for stop after cycle point, now the workflow will not "finish" so the pool will not need re-polulating for the workflow to continue. This is much nicer for Cylc (no discontinuity), the user (no extra commands) and provenance (direct continuation of previous run).

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • Changelog entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

@oliver-sanders oliver-sanders added the doc Documentation label Jul 11, 2024
@oliver-sanders oliver-sanders added this to the 8.3.3 milestone Jul 11, 2024
@oliver-sanders oliver-sanders requested a review from wxtim July 11, 2024 14:14
@oliver-sanders oliver-sanders self-assigned this Jul 11, 2024
@oliver-sanders oliver-sanders force-pushed the example-extending-workflow-2 branch from e93d98a to 4526856 Compare July 12, 2024 08:03
@oliver-sanders oliver-sanders force-pushed the example-extending-workflow-2 branch from 4526856 to 497a74e Compare July 12, 2024 09:08
@wxtim wxtim merged commit 9d985f2 into cylc:master Jul 15, 2024
26 of 27 checks passed
@oliver-sanders oliver-sanders deleted the example-extending-workflow-2 branch July 15, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants