Gated release: from Promote to Production
Last updated: November 10, 2026
With Gated Release, Studio prepares your plugin for review, while your technical team controls when it's deployed to Canvas.
Unlike Direct Release, promoting a plugin does not automatically install it on your Canvas instance.
Before getting started, your Studio Admin must connect your organization's code repository. For setup instructions, see the Studio Admin Guide.
Where Your Plugin Runs
Your organization has two kinds of Canvas instances:
Test instance(s): where Studio deploys your plugin while you build and test it. Work in progress only ever reaches this instance.
Release instances: the instances your team uses day to day. Under Gated Release, a plugin reaches these only after your technical team reviews it and deploys it.
How Gated Release Works
After completing testing and Final Review:
You Promote (in Studio). Studio opens a pull request (GitHub) or merge request (GitLab) in your team's repository containing the finished plugin's source. That's where Studio's job ends, it does not install anything on your release instances.
Your technical team reviews and merges (in GitHub/GitLab). A reviewer approves and merges the request on your team's schedule. They can merge it as is or edit it first. The plugin's code is now in your repository.
Your team installs it on your Canvas instance. Your developers deploy it with the Canvas CLI (
canvas login, thencanvas deploy), by hand or from a pipeline that runs on merge. For technical instructions, see Moving to Canvas Platform. If your team keeps several plugins in one repository, see Working with a monorepo.Studio picks up your team's version. The next time you open the project, Studio brings in what your team deployed, including any edits they made during review. Your next update starts from that version, so their changes are never overwritten.
Because step 3 is yours, Gated release gives your technical team the final say over what reaches production. If you'd rather Studio install straight to a Canvas instance with no repository step, your Studio Admin can switch you to Direct release instead.
Updating a Promoted Plugin
To make changes to a previously promoted plugin:
Open the project and click Start an Update, or ask Studio to make a change.
Complete testing and Final Review.
Click Promote Updates to [repository].
Your technical team reviews, merges, and deploys the updated code through its release process
If your team changes the plugin's code directly in the repository, Studio brings those changes into the project. See When code changes outside Studio for details.
FAQ
Q: I merged the request Studio opened, but the plugin isn't on my Canvas instance. Why?
A: Merging adds the plugin's code to your repository but doesn't necessarily install it.
Your technical team must deploy the plugin manually or through an automated pipeline. Contact whoever manages your organization's deployments to confirm the next step.
Q: Who installs the plugin under Gated release?
A: Under Gated Release, your technical team manages deployment.
Q: Can my engineers work on the plugin before I promote it?
A: Yes. Your engineers can send in-progress changes into your Studio project, and they can try changes on your test instance without touching your release instances. See When code changes outside Studio.
Q: Can we switch from Gated to Direct Release?
A: Yes. Your Studio Admin can change the organization's release strategy to Direct Release if you prefer Studio to install plugins without the repository review step.