CircleCI Ideas

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!

  • Avatar32.5fb70cce7410889e661286fd7f1897de Guest
  • Mar 2 2018
  • Shipped
  • Attach files
  • Avatar40.8f183f721a2c86cd98fddbbe6dc46ec9
    Guest commented
    29 Jan 23:12

    YES PLEASE!

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

  • Avatar40.8f183f721a2c86cd98fddbbe6dc46ec9
    Guest commented
    09 Aug 19:48

    Is this functionality something we can rely on? 

  • Admin
    James Ma commented
    23 Sep 19:41

    for those who are following, I've taking the time to open a PR against the official docs to surface this command https://github.com/circleci/circleci-docs/pull/3751