Add, rename, reorder and remove environments

The path is set per workspace under Settings → Workspace → Environments (the gear next to Promote on an agent's page opens it). Workspace admins change it; everyone else sees the path and what runs where. Changes apply to every agent in the workspace.

The path

Each environment is a card: name, slug, what it's for, its rules (Editable for Development; Default, Protected, Requires Staging first), and how many agents run a release there (Development: every agent's draft). Arrows between the cards show the order.

Add an environment

1. 1

   Choose Add environment

   A workspace can have up to 8 environments.

2. 2

   Name and slug

   Name, up to 40 characters, unique in the workspace. The slug is made from the name (QA becomes qa; a taken one gets -2), or type your own: it starts with a letter and uses lowercase letters, numbers and dashes, up to 31. It's what the widget, chat links and the API name, and it can't change later.

3. 3

   Colour and description

   A Colour no other environment uses is suggested (eight to pick from); it marks the environment's pills and chips everywhere. What it's for is a line for your team, up to 200 characters.

4. 4

   Where in the path

   After Staging, say. New environments are offered just before the default one, so QA lands between Staging and Production.

5. 5

   Add it

   Choose Add environment. It starts empty: every agent reads Not released there until someone promotes into it. Set its rules afterwards with Edit.

Edit an environment

• Name, Colour and What it's for, for any environment, Development included. Development's place and rules don't change.
• Default environment: the one the widget, chat links and the API use when they don't name one. There's always exactly one; to move it, switch it on for another environment (it can't be switched off where it is).
• Require a release to run in <previous> first: only a release that's running in the environment before it can be promoted here.
• Only workspace admins can promote here (protected). Editors can still promote to the environments before it. Rolling it back also needs an admin.

Reorder

The arrows on a card move it left or right among the environments after Development, which stays first. A requires the previous first rule follows whatever environment ends up before it.

Remove

1. 1

   Make sure it isn't the default

   The default can't be removed ("Make another environment the default first"), and neither can Development.

2. 2

   Delete it

   The bin icon on its card. The dialog says what it costs: "3 agents lose the release they run in QA. API calls that name 'qa' stop answering, and widgets and chat links set to it answer from the default environment. Its conversations, logs and deployment history are kept."

3. 3

   Confirm

   Delete environment. Requests that still name its slug get 404 ENVIRONMENT_NOT_FOUND.

If something goes wrong