Git Product home page Git Product logo

Comments (3)

keithpitt avatar keithpitt commented on September 26, 2024 1

Totally! We're actually working on new docs at the moment and it should hopefully cover some of this stuff. It'll hopefully also cover the lifecycle of a job and what states it's in and what they mean.

Here is a list of jobs states at the moment:

  # a proper state hasn't been assigned yet. this is the default when created
  # in a pipeline context.
  PENDING = "pending".freeze

  # the job is waiting to be scheduled as part of a pipeline
  WAITING = "waiting".freeze

  # the job was waiting, but won't be run because of a previous pipeline failure
  WAITING_FAILED = "waiting_failed".freeze

  # blocked on user interaction
  BLOCKED = "blocked".freeze

  # was blocked, but won't run now because the pipeline failed
  BLOCKED_FAILED = "blocked_failed".freeze

  # was previously blocked, but now the pipeline can continue
  UNBLOCKED = "unblocked".freeze

  # it was unblocked, but a previous step failed
  UNBLOCKED_FAILED = "unblocked_failed".freeze

  # waiting for an agent to pick it up
  SCHEDULED = "scheduled".freeze

  # has been assigned to an agent, and waiting the agent to officially start it
  ASSIGNED = "assigned".freeze

  # the agent has aknowledged that it has the job
  ACCEPTED = "accepted".freeze

  # it's running
  RUNNING = "running".freeze

  # job finished
  FINISHED = "finished".freeze

  # job canceled
  CANCELING = "canceling".freeze
  CANCELED = "canceled".freeze

  # job timed out
  TIMING_OUT = "timing_out".freeze
  TIMED_OUT = "timed_out".freeze

  # skipped
  SKIPPED = "skipped".freeze

  # the job is incapable of being run
  BROKEN = "broken".freeze

If you have any other questions I'm happy to answer them here!

from docs.

plaindocs avatar plaindocs commented on September 26, 2024 1

Thanks @nickofthyme - I've added an internal ticket to look at that diagram with a view to adding some more description.

from docs.

nickofthyme avatar nickofthyme commented on September 26, 2024

I think this would still be nice to tuck a full description of the statuses away in the job-states somewhere. The current diagram below is great but it does not clearly explain when you would get a given status, beyond inferring from the state name itself. Especially when you can have a non-obvious job statuses, such as BROKEN for skipped jobs.

image

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.