Skip to content

Functions

enableWorkspaces

enableWorkspaces(opts?): Promise<WorkspacesStatus>

Turn Workspaces on for the organization, so sandboxes can be created in it. It needs the owner role, and does nothing if everything is already in place.

  1. Accept the terms (only with acceptTerms: true).
  2. Link a GitHub account, if the organization has none: the service requires one. This opens a browser on GitHub, where you choose the account, and waits for you to finish (up to 10 minutes). The Chainguard GitHub App must be installed on the account; if it is not, GitHubAppNotInstalledError gives the page to install it from.
  3. Turn the feature on with the plan’s allowance. This also turns on Chainguard Checks, which the same switch controls.

EnableOpts = {}

Promise<WorkspacesStatus>