-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add serial-groups section to config reference #9259
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe right now we only support the individual job and not a group of jobs. We should be clear that this is specific for one job and that we will add "groups of jobs" in the future.
Does this work: "The |
''' | ||
====== `serial-group` | ||
|
||
The `serial-group` key is used to add a property to a job to allow a group of jobs to run in series, rather than concurrently, across an organization. Serial groups control the orchestration of jobs across an organization, not just within projects and pipelines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should note that if jobs with the same serial-group key within the same project have lower pipeline numbers, they will be skipped if a job from a higher pipeline number has already been executed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, that might even deserve its own subsection or somehow highlighted as an important detail.
Something along the lines of:
Serial groups are started in order of joining the queue but are accepted based on pipeline number, if a group is currently waiting/running and another group in the same project attempts to join the queue with a lower pipeline number, it will be not_run
to maintain order integrity.
If there are no serial groups waiting/running, a pipeline with a lower number can start, such as restoring back to a previous pipeline via a rerun workflow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can add a caution section
Description
Add details of the serial-group key to the configuration reference
Reasons
A link to a GitHub and/or JIRA issue (if applicable).
Otherwise, a brief sentence about why you made these changes.
Content Checklist
Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.
Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸: