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

Semantics of nextStep in final step of workflow #448

Open
kezike opened this issue Feb 17, 2025 · 2 comments
Open

Semantics of nextStep in final step of workflow #448

kezike opened this issue Feb 17, 2025 · 2 comments
Assignees
Labels
ready for PR Issue ready to be resolved via a Pull Request

Comments

@kezike
Copy link

kezike commented Feb 17, 2025

In the final step of a workflow step, should nextStep be the same as the current stepName or should it be undefined? I’ve seen examples where the former is considered a cycle and the latter is considered correct, but this should be clarified in the specification. If we accept the latter approach (undefined value of nextStep in final step), we would need to make this an optional value in the specification text and the OpenAPI definition.

@dlongley
Copy link
Contributor

Yeah, it should be considered a cycle (and, therefore, an error), i.e., no step should have as its next step the same step. We should also suggest a maximum total number of steps to prevent longer cycles (there are implementations today that have their own built-in maximums, but we should at least mention this and suggest maximum number in the spec).

I agree that we should define nextStep as optional (or require it to be null to signal the final step, TBD).

@msporny
Copy link
Contributor

msporny commented Feb 18, 2025

The group discussed this on the 2025-02-18 telecon. @dlongley noted that a PR needs to be raised that nextStep should never refer to the current step. We should suggest what the maxmimum number of steps but not put a hard limit. If nextStep is not present, the current step is the last step.

@msporny msporny added the ready for PR Issue ready to be resolved via a Pull Request label Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for PR Issue ready to be resolved via a Pull Request
Projects
None yet
Development

No branches or pull requests

3 participants