Skip to content

[PIPE-5335] add not_run to upstream docs + job statuses graph #9786

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.

Sign up for GitHub

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[PIPE-5335] add not_run to upstream docs + job statuses graph #9786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9e795d
add not_run to upstream docs + job statuses graph
SashaLsnko Nov 21, 2025
0e7ff8f
update server job statuses diagram
SashaLsnko Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/guides/modules/orchestrate/pages/jobs-steps.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ stateDiagram-v2
state "blocked or not running" as pending
blocked --> pending : Job instructed to start but not yet started
blocked --> unauthorized : Trying to use a context without permission
blocked --> not_run : Job's dependencies will never be satisfied

pending --> running

Expand All @@ -102,6 +103,7 @@ stateDiagram-v2
success --> [*]
canceled --> [*]
unauthorized --> [*]
not_run --> [*]
----

.CircleCI server job status transitions
Expand All @@ -117,17 +119,18 @@ stateDiagram-v2

pending --> running

pending --> skipped : Only build PRs setting enabled<br/>ci-skip<br/>No project found<br/>Abusive<br/>Sanctioned
pending --> not_run : Only build PRs setting enabled
pending --> blocked : Rerun

running --> canceled
pending --> canceled
blocked --> canceled

pending --> failed : Abusive / Sanctioned
running --> failed
running --> success

skipped --> [*]
not_run --> [*]
success --> [*]
failed --> [*]
canceled --> [*]
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/modules/orchestrate/pages/workflows.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,10 +204,11 @@ workflows:
- success
- failed
- canceled
- not_run
----

* The `test` job waits for the `build` job, and only runs if the `build` job is successful.
* The `cleanup` job waits for the `test` job, and runs regardless of whether the `test` job succeeds, fails, or is canceled.
* The `cleanup` job waits for the `test` job, and runs regardless of whether the `test` job succeeds, fails, is canceled or is not run.

TIP: Refer to the xref:reference:ROOT:configuration-reference.adoc#requires[Requires] section of the configuration reference.

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/modules/ROOT/pages/configuration-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2794,7 +2794,7 @@ Possible types of `requires` items:
* Map of job name to status (a required job that must attain the specified status for the job to start) +
* Map of job name to a list of statuses (a required job that must attain one of the specified status for the job to start)

The possible *status* values are: `success`, `failed` and `canceled`.
The possible *status* values are: `success`, `failed`, `canceled` and `not_run`.
|===
--

Expand All @@ -2819,6 +2819,7 @@ workflows:
- deploy:
- failed
- canceled
- not_run

----

Expand Down