Add 'circleci step halt' documentation

I've been looking for ways to properly (cleanly) stop a job once it's started based on some conditions of the git repository. While searching for this, I came across several support questions with a similar answer: "use `circleci step halt`". Apparently this stops the job and marks it as successful.

The thing is, I can't seem to find any official documentation. Would be a great addition since it's very useful!

  • Guest
  • Mar 2 2018
  • Shipped
  • Attach files
  • James Ma commented
    23 Sep, 2019 07:41pm

    for those who are following, I've taking the time to open a PR against the official docs to surface this command

  • Kenny Williams commented
    9 Aug, 2019 07:48pm

    Is this functionality something we can rely on? 

  • Ulrich Petri commented
    29 Jan, 2019 11:12pm


    I've just spend 20 minutes trying to find the magic incantation necessary to do this. 

  • and 9 more