Merge pull request #45 from porter-dev/autorollback-docs

add autorollback docs
porter-dev · Feb 14, 2024 · 259b892 · 259b892
2 parents 5c0d51b + 59ce026
commit 259b892
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/deploy/configuration-as-code/reference.mdx b/deploy/configuration-as-code/reference.mdx
@@ -28,6 +28,8 @@ The following is a full reference for all the fields that can be set in a `porte
 - [env](#env) \- the environment variables for the app.
 - [predeploy](#predeploy) \- the pre-deploy job for the app.
   - **run** - the run command for the pre-deploy job.
+- [autoRollback](#autoRollback) \- the auto-rollback settings for the app.
+  - **enabled** - whether auto-rollback is enabled.
 
 ### `version`
 
@@ -102,3 +104,14 @@ env:
 predeploy:
   run: echo "predeploy"
 ```
+
+### `autoRollback`
+
+`object` - optional
+
+When this attribute is enabled, Porter will automatically rollback all services in the app to the latest previously successfully-deployed version if the any service of the new version fails to deploy.
+
+```yaml
+autoRollback:
+  enabled: true
+```