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

Add serial-groups section to config reference #9259

Merged
merged 5 commits into from
Mar 7, 2025

Conversation

rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented Mar 5, 2025

Description

Add details of the serial-group key to the configuration reference

Screenshot 2025-03-07 at 15 44 42

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) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

Copy link
Contributor

@nathanfishcircleci nathanfishcircleci left a 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.

@rosieyohannan
Copy link
Contributor Author

rosieyohannan commented Mar 6, 2025

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 key is configurable per job. It is not possible to configure the key for a group of jobs at this time."

@rosieyohannan rosieyohannan marked this pull request as ready for review March 6, 2025 13:31
@rosieyohannan rosieyohannan requested review from a team as code owners March 6, 2025 13:31
'''
====== `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.
Copy link
Contributor

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.

cc: @nathanfishcircleci @liamclarkedev

Copy link
Contributor

@liamclarkedev liamclarkedev Mar 6, 2025

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.

Copy link
Contributor Author

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

@rosieyohannan rosieyohannan merged commit 0d9fd2a into master Mar 7, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants