docs: document global rules for safe to apply mode

giovannibaratta · Nov 26, 2023 · 168c943 · 168c943
1 parent 1a422ea
commit 168c943
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/jekyll/README.md b/jekyll/README.md
@@ -140,6 +140,20 @@ global:
         - "DELETE"
 ```
 
+### Safe to apply mode
+
+When using the safe to apply mode, The `safeToApply` parameter can be used to specify the list of actions that are always safe to apply. If in the plan there are only resources that specify the action listed in the parameter, the application will exit with code `0` indicating that the plan can be applied with `-auto-approve`.
+
+```yaml
+.terraapprove.yaml
+
+global:
+  safeToApply:
+    allResources:
+      actions: # Supported values are "CREATE", "UPDATE_IN_PLACE", "DELETE"
+        - "CREATE"
+```
+
 ## Alternatives
 
 This is a list of alternative tools (definitely more mature than TerraApprove) that can be used to achieve the same (or similar) results: