Skip to content

Commit d1ed6c2

Browse files
Updated README
1 parent 6ebbf6a commit d1ed6c2

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The Overmind plugin installs the Overmind CLI (and GitHub CLI) and executes one
1919
| `tags` | A comma-separated list of key=value tags to attach to the change (only used with `submit-plan` action) | No |
2020
| `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 |
2121
| `comment_provider` | Where `wait-for-simulation` should post comments when `post_comment=true`. Must be one of: `github`, `gitlab`. | No |
22+
| `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 |
2223

2324
## Usage
2425

@@ -139,6 +140,21 @@ deploy:
139140
comment_provider: gitlab
140141
```
141142

143+
### Fail-safe: allow deployment to continue on plugin errors
144+
145+
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`:
146+
147+
```yaml
148+
- name: Submit Plan to Overmind
149+
use: https://github.com/your-org/env0-plugin
150+
inputs:
151+
action: submit-plan
152+
api_key: ${OVERMIND_API_KEY}
153+
on_failure: pass # deployment continues even if this step fails
154+
```
155+
156+
Use `on_failure: pass` when the Overmind integration is optional and you do not want plugin failures to block deployments.
157+
142158
### Complete Example
143159

144160
Here's a complete example that uses the plan/change lifecycle actions:

0 commit comments

Comments
 (0)