From d1ed6c2936147765fbe660c457578aa9e8477419 Mon Sep 17 00:00:00 2001 From: Dylan Ratcliffe Date: Wed, 11 Feb 2026 11:41:01 +0000 Subject: [PATCH] Updated README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 3dc57ff..2f53e79 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ The Overmind plugin installs the Overmind CLI (and GitHub CLI) and executes one | `tags` | A comma-separated list of key=value tags to attach to the change (only used with `submit-plan` action) | No | | `post_comment` | Whether `wait-for-simulation` should post the Overmind markdown to GitHub PR or GitLab MR. Defaults to `true` when running against a PR/MR, otherwise `false`. When `true`, `comment_provider` must be set. | No | | `comment_provider` | Where `wait-for-simulation` should post comments when `post_comment=true`. Must be one of: `github`, `gitlab`. | No | +| `on_failure` | Behavior when the plugin step errors. `fail` (default) fails the step and blocks the deployment; `pass` allows the deployment to continue even if this step errors. Must be one of: `fail`, `pass`. | No | ## Usage @@ -139,6 +140,21 @@ deploy: comment_provider: gitlab ``` +### Fail-safe: allow deployment to continue on plugin errors + +By default, if the plugin step fails (e.g. Overmind API error, missing env var, network issue), env0 treats the step as failed and can block the deployment. To allow the deployment to continue even when this step errors, set `on_failure: pass`: + +```yaml + - name: Submit Plan to Overmind + use: https://github.com/your-org/env0-plugin + inputs: + action: submit-plan + api_key: ${OVERMIND_API_KEY} + on_failure: pass # deployment continues even if this step fails +``` + +Use `on_failure: pass` when the Overmind integration is optional and you do not want plugin failures to block deployments. + ### Complete Example Here's a complete example that uses the plan/change lifecycle actions: