Skip to content

Commit 0287ecf

Browse files
docs(relay): say which relay values need a forced deploy
The guidance split force by secret versus variable, but what matters is where the relay reads the value. Values read in the Worker's startup code need force; env bindings and resource settings such as RELAY_DOMAIN do not. Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
1 parent 3b795ee commit 0287ecf

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

‎.github/workflows/deploy-relay.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
workflow_dispatch:
1212
inputs:
1313
force:
14-
description: Redeploy every resource. Replaces the Postgres runtime role; only for secrets.
14+
description: Redeploy every resource. Needed after changing a Clerk, APNs or FCM value. Replaces the Postgres runtime role.
1515
type: boolean
1616
default: false
1717

‎docs/operations/release.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,11 +141,18 @@ Required `production` environment secrets:
141141
- `APNS_PRIVATE_KEY`
142142

143143
After changing a variable or secret, run the **Deploy T3 Connect relay** workflow manually from
144-
`main`. The tunnel cleanup modes are Worker `env` bindings, so a normal run applies them. Alchemy does
145-
not redeploy the Worker when only a value read in the Worker's startup code changes
146-
([alchemy-run/alchemy#1831](https://github.com/alchemy-run/alchemy/issues/1831)), so any other
147-
variable or secret needs the run with **force** checked. A forced run also replaces the Postgres
148-
runtime role and its password ([alchemy-run/alchemy#1832](https://github.com/alchemy-run/alchemy/issues/1832)).
144+
`main`. Whether it needs **force** depends on where the relay reads the value:
145+
146+
- The tunnel cleanup modes are Worker `env` bindings, and `RELAY_DOMAIN`, `RELAY_API_ZONE_NAME`, and
147+
`RELAY_TUNNEL_ZONE_NAME` configure deployed resources. A normal run applies them.
148+
- `CLERK_SECRET_KEY`, `CLERK_PUBLISHABLE_KEY`, `CLERK_JWT_AUDIENCE`, the `APNS_*` values, and
149+
`FCM_SERVICE_ACCOUNT` are read in the Worker's startup code.
150+
Alchemy does not redeploy the Worker when only one of these changes
151+
([alchemy-run/alchemy#1831](https://github.com/alchemy-run/alchemy/issues/1831)), so they need the
152+
run with **force** checked.
153+
154+
A forced run also replaces the Postgres runtime role and its password
155+
([alchemy-run/alchemy#1832](https://github.com/alchemy-run/alchemy/issues/1832)).
149156

150157
The account-scoped repository credentials are consumed by Alchemy while provisioning relay stages; they
151158
are not bound into the relay Worker. The production deployment uses an Axiom personal access token,

0 commit comments

Comments
 (0)