Loading Leap…

Versions and Deployments

Create a version of Main or of a workspace, deploy it to an environment in the same step or later, and manage your environments.

Versions and Deployments

Once your design works, it's time to ship it. A version is a named snapshot of your design — of Main, or of a workspace you're working in — and a deployment puts a version into an environment — the place your game connects to. You manage all three from the Deployment menu in the header.

How It Fits Together

  1. Change your design — when you edit Main directly, every change you save is on Main. When your project uses workspaces, you work in a workspace, and merging it puts its changes on Main.
  2. Create a version where you are. On Main, it tags Main as it is at that moment. In a workspace, it holds that workspace's saved changes instead — see Creating a Version from a Workspace below.
  3. Deploy the version to an environment — in the same step, with Deploy to, or later from the menu. Game clients connecting to that environment receive the version most recently deployed to it.

Creating a Version

Step 1: Open the Deployment Menu

In the header, click the arrow beside the rocket. The Deployment menu lists your environments, with the version each one is running, and your versions.

The rocket itself is Build & Deploy: one click makes a version of what you're working on and deploys it to the environment chosen under Build & Deploy to, at the bottom of the menu.

Step 2: Click "Create version"

Next to Versions, click the + ("Create version"). The Create New Version dialog opens.

Step 3: Fill In the Version

  • Version — a version number in major.minor.patch form, e.g. 1.0.0. Leap fills in the next patch number after your highest version — 1.0.0 for the first — so you can usually keep it. It must be different from your existing versions; otherwise the field says "This version number already exists." In a workspace, the version's name also starts with the workspace's name, e.g. w-stronger-archers-1.0.0 — see Creating a Version from a Workspace below.
  • Description — what the version contains. Optional; up to 255 characters of letters, numbers, spaces, underscores, hyphens and periods.
  • Deploy to — optional, and set to Don’t deploy each time the dialog opens. Pick one of your environments to deploy the version there as soon as it's created; the dialog notes "Game clients on {environment} get this version as soon as it’s created." Leave Don’t deploy to deploy it later from the Deployment menu.

When you edit Main directly, the dialog notes "Includes every saved change on main."

Step 4: Create It

The button reads Confirm, or Create & deploy once you've picked an environment under Deploy to. It stays unavailable until Version holds a number. Click it:

  • Confirm creates the version. Leap confirms "New version created successfully!" — in a workspace, "Version {version} created from workspace “{workspace}”!" — and the version appears in the menu.
  • Create & deploy creates the version, then deploys it to the environment you picked. Leap confirms "Version {version} created and deployed to {environment}!" — in a workspace, "Version {version} created from workspace “{workspace}” and deployed to {environment}!" — and the environment now shows the new version.

While Leap works, the button reads Creating… or Creating & deploying…. When the version comes from a workspace, or you picked Deploy to, a progress dialog also shows each step — such as "Checking workspace “{workspace}”…", "Creating version {version} from workspace “{workspace}”…" and "Deploying version {version} to {environment}…" — and blocks Leap Studio until it's done.

If the deploy fails after the version was created, the dialog closes and Leap says "Version {version} was created but not deployed: {reason}". The version exists, so deploy it from the menu (see Deploying a Version below) rather than creating it again.

If someone else created a version with the same name in the meantime, the dialog stays open and says "Version {version} already exists. Pick another number."

When you edit Main directly, three things can come up before the version is created:

  • Unsaved edits — a version includes only saved changes, so Leap lists your unsaved edits and asks what to do: Save all and continue saves them and creates the version, Continue without them creates it without them, and Stay takes you back to the dialog.
  • Problems on Main — if Main has a problem, such as an element that uses one that no longer exists, the dialog stays open, shows "This version wasn’t created:" and lists each problem with How to fix it. Fix the elements, save them, and click the button again. These are the same problems a merge checks for; see "When a Merge Is Refused" in Working with Workspaces.
  • Changes that overlap a merge — if your changes on Main overlap with changes merged from a workspace, the dialog closes and Leap says "Main’s changes overlap with changes merged from a workspace. Review them from the bar under the header, then create the version again." See "The Bar Under the Header" in Editing Main Directly.

Important: What a version contains depends on where you create it. When you edit Main directly, it includes every change saved on Main. When your project uses workspaces, a version created on Main captures Main's latest merge, and one created in a workspace holds that workspace's saved changes.

Creating a Version from a Workspace

When your project uses workspaces, you can deploy a workspace before you merge it — for example to try a balance change in your game on a QA environment. Open the workspace and create the version as above; pick the environment under Deploy to to deploy it in the same step. The version holds the workspace's saved changes, which aren't merged into Main, and Main doesn't change.

A version created from a workspace is named after it: w-, the workspace's name in lowercase with a dash for each run of spaces or symbols (at most 32 characters), then the number — e.g. w-stronger-archers-1.0.0 for the workspace "Stronger archers". The dialog shows the w-stronger-archers- part in front of the Version field, so you only type the number. Each workspace counts on its own: its first version is 1.0.0, the dialog suggests the workspace's next patch ("this workspace’s next patch is suggested"), and its versions don't change the number suggested for Main's next version. Before the version is created:

  • Unsaved edits — a version includes only saved changes, so Leap lists your unsaved edits and asks what to do: Save all and continue, Continue without them or Stay.
  • Problems in the workspace — Leap checks the workspace the same way a merge does. If it has a problem, the dialog stays open, shows "This version wasn’t created:" and lists each problem with How to fix it.

Important: A workspace keeps Main as it was when you created the workspace. If changes were merged into Main since, the dialog says "Main has changed since “{workspace}” was created." Those changes aren't in the version, so deploying it to an environment that runs a newer version of Main takes them away from the players there until you deploy again. Environments are shared by the whole project: everyone using the environment gets the workspace's changes.

You can keep working in the workspace and create and deploy more versions of it — w-stronger-archers-1.0.1, and so on. Each keeps exactly what the workspace held when you created it: merging or closing the workspace later doesn't change it, and it can still be deployed.

The w- name is what marks a workspace's version in the Deployment menu. In the browser you created it from, the Promote Version dialog also names the workspace, e.g. "w-stronger-archers-1.0.0 · from workspace “Stronger archers”".

Environments

Every project starts with an environment called Dev. Add others as you need them — for example QA or Beta.

  • Add an environment — click the + ("Add environment") next to Environments. Enter a Name (e.g. "QA", "Beta" or "Canary") — letters, numbers, spaces, hyphens or underscores, starting with a letter or number — and click Create. Leap derives the environment's slug from the name; your game uses the slug to connect.
  • Rename an environment — click the pencil ("Rename environment") next to it. Renaming changes the name only: the slug stays the same, so games already connecting to it keep working.
  • Delete an environment — click the bin ("Delete environment") and confirm: "Delete the "{name}" environment? This cannot be undone."

Each environment shows the version it's running — e.g. v1.0.0, or a workspace's version by its name, e.g. w-stronger-archers-1.0.0 — or "No version deployed".

Tip: If a project has no environments at all, Leap creates Dev again the next time you open the project.

Deploying a Version

Step 1: Click "Deploy"

In the Deployment menu, click Deploy next to the environment. The Promote Version to {environment} dialog opens.

Step 2: Pick the Version

Under Select Version, choose the version to deploy. The version the environment is already running isn't listed; if there's nothing else to choose, the dialog explains: "No other version is available for {environment}. Create a new version first." A version created from a workspace starts with w- and its workspace's name, e.g. w-stronger-archers-1.0.0. If two versions share a name, they're listed as "1.0.6 (1)" and "1.0.6 (2)".

Step 3: Promote

Click Promote. Leap confirms "Version {version} deployed to {environment}!", and the environment now shows that version.

Going Back to an Earlier Version

There's no separate rollback: deploy the earlier version to the environment again. An environment always serves the version most recently deployed to it.

Your Project's Identifiers

Your project's identifiers are listed in Project settings — open the project menu in the header and click the cog:

  • Identity — your Organization ID and the project's Project ID.
  • Environment — each environment's Name, Slug, Environment ID and Deployed version.

Next Steps

Once your game is playing on an environment, see what players did there in Analysing Your Game.