docs(ci): document usage of depends_on in pipeline generation

Document how we use `depends_on` to make sure that a failure of the Style step does not prevent all the other integration tests from running. Signed-off-by: Patrick Roy <[email protected]>
firecracker-microvm · Jul 2, 2024 · 33ccd4d · 33ccd4d
1 parent d7c6038
commit 33ccd4d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/.buildkite/common.py b/.buildkite/common.py
@@ -248,6 248,12 @@ def __init__(self, initial_steps=None, **kwargs):
  step_build = group("🏗️ Build", build_cmds, **self.per_arch)
  self.steps  = [step_build, "wait"]
 
  # If we run initial_steps before the "wait" step above, then a failure of the initial steps
  # would result in the build not progressing past the "wait" step (as buildkite only proceeds past a wait step
  # if everything before it passed). Thus put the initial steps after the "wait" step, but set `"depends_on": null`
  # to start running them immediately (e.g. without waiting for the "wait" step to unblock).
  #
  # See also https://buildkite.com/docs/pipelines/dependencies#explicit-dependencies-in-uploaded-steps
  if initial_steps:
  for step in initial_steps:
  step["depends_on"] = None