Skip to content

Add page on serial execution #9297

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

Merged
merged 9 commits into from
Apr 2, 2025

Conversation

rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented Mar 25, 2025

Description

Create overview page for serial execution across an org

Reasons

New feature

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

@liamclarkedev liamclarkedev left a comment

Choose a reason for hiding this comment

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

Some additional sections that might be worth mentioning around controlling these groups:

  • Cancelling a workflow via the UI whilst a serial group is running will release the group for any waiting.
  • Cancelling a workflow or "serial start"/lock job via the API will do the same.
  • Clicking on a "serial start"/lock job node in the UI whilst a job inside the serial group is running will provide a dialog to release the group.

@rosieyohannan rosieyohannan marked this pull request as ready for review April 2, 2025 09:45
@rosieyohannan rosieyohannan requested review from a team as code owners April 2, 2025 09:45

Serial group jobs are displayed in the CircleCI web app in workflow graphs with the following visual elements:

* A job in a serial group is preceded by a block with a lock icon to show the start of the serial group. A serial group end block follows the job.
Copy link
Contributor

Choose a reason for hiding this comment

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

~~ Should this be key icon? Similar mentions below, but I won't comment on all of them.

Suggested change
* A job in a serial group is preceded by a block with a lock icon to show the start of the serial group. A serial group end block follows the job.
* A job in a serial group is preceded by a block with a key icon to show the start of the serial group. A serial group end block follows the job.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh yes good spot! Thanks

@rosieyohannan rosieyohannan merged commit 89661e7 into master Apr 2, 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.

3 participants