You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/platform/enterprise/forks.mdx
+38-14Lines changed: 38 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ On Sim Cloud, your organization may also need the feature turned on for your acc
29
29
30
30
### 1. Open Forks
31
31
32
-
Go to **Settings → Organization → Workspace forks** in the workspace you want to fork from (or manage).
32
+
Go to **Settings → Workspace → Workspace forks** in the workspace you want to fork from (or manage).
33
33
34
34
<Imagesrc="/static/enterprise/forks-list.png"alt="Workspace Forks settings page showing Parent and Forks sections with Docs, See activity, and Create fork actions"width={900}height={369} />
35
35
@@ -57,12 +57,12 @@ Everything under **Copy resources** starts **selected**. That is usually what yo
57
57
Click **Fork**. The child workspace is created immediately. Deployed workflows land as **drafts** in the child. Large content (table rows, knowledge base files, file blobs) may finish copying in the background — watch **Activity** on the source workspace.
58
58
59
59
<Callouttype="info">
60
-
Only **deployed** workflows are forked. Drafts and undeployed work stay in the parent. If the parent has nothing deployed, the child starts with a blank starter workflow.
60
+
Only **deployed** workflows are forked, and only the ones that are [synced](#synced-workflows). Drafts and undeployed work stay in the parent. If there is nothing to copy, the child starts with a blank starter workflow.
61
61
</Callout>
62
62
63
63
### 3. Open the parent edge (from the child)
64
64
65
-
Open the **child** workspace → **Settings → Organization → Workspace forks**. On the **Parent** row, open the menu and choose **Edit mappings**.
65
+
Open the **child** workspace → **Settings → Workspace → Workspace forks**. On the **Parent** row, open the menu and choose **Edit mappings**.
66
66
67
67
Child rows (when you are on the parent) only offer **Open workspace** and **Disconnect** — mapping and sync are owned by the child configuring how it relates to its parent.
68
68
@@ -117,16 +117,35 @@ On success you will see a toast such as **Pushed to "…"** or **Pulled from "
117
117
118
118
---
119
119
120
-
## Excluded workflows
120
+
## Synced workflows
121
121
122
-
The **Excluded workflows** section on the Forks page lists this workspace's deployed workflows in their sidebar folder structure. Check a workflow — or a whole folder at once — to keep it out of forking entirely. Think of it as a `.gitignore` for syncs:
122
+
The **Synced workflows** section on the Forks page lists this workspace's deployed workflows in their sidebar folder structure, each with a checkbox. **Checked means the workflow syncs.** Uncheck one — or a whole folder at once — to keep it out of forking entirely. Think of an unchecked workflow as `.gitignore`d:
123
123
124
124
-**Never sent** — pushes from this workspace do not carry it, the other side pulling from this workspace does not receive it, and creating a new fork does not copy it
125
-
-**Never touched** — a sync into this workspace will not overwrite or archive it, even if its counterpart was deleted on the other side
125
+
-**Never touched** — a sync into this workspace will not overwrite or archive it, even if its counterpart was deleted on the other side. It stays deployed and keeps serving, and a previously-synced counterpart on the other side keeps running on its last deployed version.
126
126
127
-
The setting belongs to **this workspace's copy** only. Excluding a workflow here does not exclude its counterpart in the parent or a fork — each workspace manages its own list. If the pair has synced before, the link between them is kept, so un-excluding later resumes updating the same counterpart instead of creating a duplicate.
127
+
The checkbox list belongs to **this workspace's copy** only. Unchecking a workflow here does not unsync its counterpart in the parent or a fork — each workspace manages its own list. If the pair has synced before, the link between them is kept, so re-checking later resumes updating the same counterpart instead of creating a duplicate.
128
128
129
-
**Example:** a staging fork excludes `Scratch experiment` so it can never reach production, and production excludes `Billing hotfix` so no push from staging can ever overwrite it.
129
+
On the sync page, unsynced workflows still appear in the **Deployed workflows** list, greyed out, with a tooltip naming which workspace they are unsynced in. The sync will not touch them.
130
+
131
+
**Example:** a staging fork leaves `Scratch experiment` unchecked so it can never reach production, and production leaves `Billing hotfix` unchecked so no push from staging can ever overwrite it.
132
+
133
+
### Sync new workflows by default
134
+
135
+
Above the list, **Sync new workflows by default** decides where a **newly created** workflow starts:
136
+
137
+
| Setting | A new workflow… |
138
+
|---------|-----------------|
139
+
|**Sync** (default) | joins fork sync — it arrives checked and syncs as soon as you deploy it |
140
+
|**Don't sync**| starts outside fork sync — it arrives unchecked and only syncs after you check it |
141
+
142
+
Three things to know:
143
+
144
+
-**It applies to the whole fork lineage.** The toggle writes every workspace in the lineage — the root, every ancestor, every descendant — so a parent and its forks can never disagree about what "new" means. Any workspace admin in the lineage can change it, and each workspace whose value changes gets its own audit entry naming the workspace the change came from. A new fork inherits the value at creation.
145
+
-**It is forward-only.** Flipping it never moves an existing workflow in or out of sync. The checkbox list above stays the record of what syncs.
146
+
-**"New" means genuinely new.** Creating, duplicating, or importing a workflow takes this setting, as does the blank starter workflow a fork gets when there is nothing to copy. A workflow that arrives as a **copy** — from a fork, or from a push or pull — ignores this setting. Only synced workflows are copied, and they always arrive synced, so a workflow you deliberately synced never lands unsynced on the other side.
147
+
148
+
**Example:** a template workspace turns this off so every scratch workflow the team creates stays local, then checks only the handful meant to reach the forks.
130
149
131
150
---
132
151
@@ -155,6 +174,8 @@ Expand a row for names of workflows and resources that were created, updated, or
155
174
|--------|-----|
156
175
| See Forks / create a fork | Admin on this workspace (+ feature available) |
157
176
| Sync / edit mappings | Admin on **both** sides of the edge |
177
+
| Check / uncheck **Synced workflows**| Admin on the workspace those workflows live in |
178
+
| Change **Sync new workflows by default**| Admin on any one workspace in the lineage — the change applies to every member |
158
179
| Rollback | Admin on the workspace the sync landed in |
159
180
| Disconnect | Admin on **this** side only (you can disconnect even without access to the other workspace) |
160
181
| Open the other workspace | You must be a member of that workspace |
@@ -169,9 +190,9 @@ How each resource behaves at **fork** time vs **sync** time. Use this when you a
169
190
170
191
| Resource | Fork | Sync |
171
192
|----------|------|------|
172
-
| Deployed workflows | Copied as drafts (unless excluded) | Updated / created / archived (force overwrite) |
193
+
| Deployed workflows | Copied as drafts when [synced](#synced-workflows)| Updated / created / archived (force overwrite) |
173
194
| Undeployed workflows | Not copied | Not synced |
174
-
|[Excluded workflows](#excluded-workflows)| Never | Never — not sent, not overwritten, not archived |
195
+
|[Unsynced workflows](#synced-workflows)| Never | Never — not sent, not overwritten, not archived |
@@ -191,11 +212,11 @@ How each resource behaves at **fork** time vs **sync** time. Use this when you a
191
212
192
213
### Workflows
193
214
194
-
Only **deployed** workflows move. Deploy is the commit; sync is the force push/pull of those commits. Workflows marked [excluded](#excluded-workflows)never move in either direction.
215
+
Only **deployed** workflows move, and only the ones checked under [Synced workflows](#synced-workflows). An unsynced workflow never moves in either direction.
195
216
196
217
| Feature | Behavior |
197
218
|---|----------|
198
-
|**Fork**| Each deployed workflow becomes a **draft** in the child. Run history is not copied. Only folders that contain a copied workflow are kept. |
219
+
|**Fork**| Each synced deployed workflow becomes a **draft** in the child. Run history is not copied. Only folders that contain a copied workflow are kept. |
199
220
|**Sync**| The change list shows what will be updated, created, or archived. The target is overwritten for those workflows. |
200
221
201
222
**Example:** Parent has `Support triage` deployed and `WIP experiment` as a draft. The fork gets only `Support triage` as a draft. A later push updates the child from the parent’s latest deploy of `Support triage`.
@@ -370,13 +391,16 @@ Schedules, webhooks, and triggers are not live in the child until you **deploy**
370
391
-**Rollback ≠ undo copies** — Workflow versions roll back; copied resources can remain as orphans.
371
392
-**Disconnect is permanent** — You cannot “reconnect” the same edge; you would fork again into a new workspace.
372
393
-**No grandparent sync** — Only the direct parent↔child pair.
394
+
-**The sync default is lineage-wide** — **Sync new workflows by default** is one shared setting for the whole lineage, so changing it from a fork also changes it in the parent and every sibling fork.
373
395
374
396
---
375
397
376
398
<FAQitems={[
377
399
{ question: "Why is Sync greyed out?", answer: "Usually a blocking reference, an unmapped credential or secret, or a required dependent field (label, channel, document, …) still empty. Open Blocking sync and the mapping sections — each row explains what to fix. Sync also stays disabled while details are loading or if loading failed (reload the page)." },
378
400
{ question: "Is sync a merge?", answer: "No. Deploy is like a commit; sync is a force push or force pull of deployed workflows onto the target. Use Rollback only for the last sync into a workspace, and remember copied resources may remain." },
379
-
{ question: "Who can disconnect a fork I cannot open?", answer: "Any admin on your side of the edge. Disconnect does not require access to the other workspace — so you are not stuck if the other side lost membership." }
401
+
{ question: "Who can disconnect a fork I cannot open?", answer: "Any admin on your side of the edge. Disconnect does not require access to the other workspace — so you are not stuck if the other side lost membership." },
402
+
{ question: "I deployed a new workflow and sync ignored it. Why?", answer: "Sync new workflows by default is off for this fork lineage, so the workflow was created outside fork sync. Open Settings → Workspace → Workspace forks and check it under Synced workflows. Turning the toggle back on only affects workflows created after that — it never moves an existing one." },
403
+
{ question: "Does turning Sync new workflows by default off stop my current syncs?", answer: "No. It is forward-only and never rewrites an existing workflow's checkbox, so everything already synced keeps syncing. It also applies to every workspace in the fork lineage, not just the one you changed it from." }
380
404
]} />
381
405
382
406
---
@@ -389,4 +413,4 @@ Self-hosted deployments turn Forks on with an environment variable instead of th
389
413
|----------|-------------|
390
414
|`FORKING_ENABLED`, `NEXT_PUBLIC_FORKING_ENABLED`| Enables workspace forking when billing is not used as the entitlement gate |
391
415
392
-
Once enabled, use the same **Settings → Organization → Workspace forks** UI as Sim Cloud. Only workspace admins can manage forks.
416
+
Once enabled, use the same **Settings → Workspace → Workspace forks** UI as Sim Cloud. Only workspace admins can manage forks.
0 commit comments