1. CircleCI Support Center
  2. Using CircleCI
  3. General

Conditionally end a running job gracefully

Avatar
Fernando

Sometimes during a build, you may want to end the job early without generating a failure.

You can end a job gracefully by running the command: circleci-agent step halt

You can combine this with if statements or when steps to control the lifecycle of the job conditionally.

Examples:

  • if statement:
run: |
    if [ "$CIRCLE_BRANCH" = "develop" ]; then
        circleci-agent step halt
    fi

 

  • when step:
- when:
    condition: false
    steps:
      - run:
          command: circleci-agent step halt
Was this article helpful?
33 out of 41 found this helpful

Comments

0 comments

Article is closed for comments.

Articles in this section

See more