From edba4dc7d0d6542e47c076ed796f67a2f4dbaeb1 Mon Sep 17 00:00:00 2001 From: Thanatat Tamtan Date: Wed, 17 Jun 2026 06:24:49 +0700 Subject: [PATCH] env-vars: document env-group redeploy behavior Changing an env group's values stores them but does not restart anything by default; pass redeploy=true (console "Update and redeploy") to roll them out immediately, which requires the deployment.deploy permission. Co-Authored-By: Claude Opus 4.8 (1M context) --- content/deployments/environment-variables.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/content/deployments/environment-variables.md b/content/deployments/environment-variables.md index 123393a..4b09036 100644 --- a/content/deployments/environment-variables.md +++ b/content/deployments/environment-variables.md @@ -28,8 +28,19 @@ If you only want to nudge a couple of values, use the partial fields below. ## Reusable env groups An **env group** is a named bag of variables you can attach to multiple -deployments. Change the group, redeploy the deployments that use it, and they -all pick up the new values. +deployments. Changing the group's values stores them but does **not** restart +anything by default — each deployment picks the new values up on its next deploy. + +To roll the change out immediately, set `redeploy: true` on `envGroup.update` +and every deployment that uses the group is redeployed to a new revision. In the +console this is the **Update and redeploy** button (the plain **Update** button +just stores the values). Paused deployments are left untouched and pick up the +new values when you resume them. + +Because `redeploy: true` rolls a new revision out to running deployments, it +requires the `deployment.deploy` permission in addition to `envgroup.update`. A +caller that holds only `envgroup.update` can still change the stored values +(leaving `redeploy` unset, or `false`). ```bash # create or update a group (replaces its contents)