Skip to content

Commit 57a6d59

Browse files
authored
docs: add warning about prebuilds incompatibility with certain features (#18689)
## Description This PR adds a warning to the prebuilds documentation about incompatibility with Workspace schedule (autostart/autostop), dormancy, and DevContainers. These configurations can interfere with prebuild behavior and should be avoided for now. Preview: ![Screenshot 2025-07-01 at 12 58 02](https://github.com/user-attachments/assets/e1a837de-b66c-4414-bd0b-471474b43b84)
1 parent 4e95b1d commit 57a6d59

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/admin/templates/extending-templates/prebuilt-workspaces.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Prebuilt workspaces
22

3+
> [!WARNING]
4+
> Prebuilds Compatibility Limitations:
5+
> Prebuilt workspaces are currently not compatible with configurations that have Workspace schedule (autostart/autostop), or Dormancy enabled.
6+
> If these features are configured, prebuilt workspaces may fail to run correctly.
7+
>
8+
> In addition, prebuilds currently do not work reliably with [DevContainers feature](../managing-templates/devcontainers/index.md).
9+
> If your project relies on DevContainer configuration, we recommend disabling prebuilds or carefully testing behavior before enabling them in production.
10+
>
11+
> We’re actively working to improve compatibility, but for now, please avoid using prebuilds with these features to ensure stability and expected behavior.
12+
313
Prebuilt workspaces allow template administrators to improve the developer experience by reducing workspace
414
creation time with an automatically maintained pool of ready-to-use workspaces for specific parameter presets.
515

0 commit comments

Comments
 (0)