Test & Deploy

A simple summary of Buildable's error management and debugging tools

Every Recipe has two distinct development environments for testing and production. Every new Recipe starts in the test environment, called Workstation, by default. Once testing is complete, developers can easily deploy the Recipe to production. Let's learn more about these powerful environments and why they're useful for rapid development.

Starting in Workstation mode

When you create a Recipe, you're automatically dropped into the Recipe's test environment, called Workstation. You'll notice you're in Workstation mode by the environment label in the header of the Recipe editor, which says Workstation in yellow. You'll also notice your Recipe's unique URL has an environment label, called 'test', embedded just before the Recipe's Trigger ID.

Testing your Recipe

When in a selected step, simply use the Test Step button on the top right of the sidebar drawer to execute the test. Once activated, the results will appear in a window that slides from the bottom of the drawer with the appropriate response.

When you're ready to test all steps of a constructed Recipe, simply use the Test Recipe button on the right side of the Recipe editor's header to activate the full recipe test. The sidebar drawer will convert to a test console, which indicates the result of each step.

You'll also notice a red error notification beside the step card that has the error if an error is present.

Deploying your Recipe to Production

Once you're done testing your Recipe, you're ready to deploy to production. To do this, you simply need to click the Deploy button in the top right corner of the screen.

When you deploy a Recipe, Buildable automatically spins up an entirely separate live environment for your Recipe, called Production. You'll notice you're in Production mode using the environment label in the header of the Recipe editor, which now says Production in green. You'll also notice your Recipe's unique URL has an environment label, called 'live', embedded just before the Recipe's Trigger ID.

If you're connecting Recipes to frontend code in user apps or internal tools, you can easily set up a config that can alternate the environment label depending on whether you're activating in staging or production. This is easy because the Recipe's Trigger ID (i.e., the last string of text in its Endpoint URL) is the exact same between Workstation and Production versions. The only difference is the environment label.

Example

If you had a Recipe in Workstation mode, its Endpoint URL would like this:

https://api.buildable.dev/trigger/v2/test-f9830903-ad71-4450-b71e-1a5a68c8b387

Once you deployed this Recipe to production, its Endpoint URL would like this:

https://api.buildable.dev/trigger/v2/live-f9830903-ad71-4450-b71e-1a5a68c8b387

Toggling between Workstation and Production

Once deployed, you can easily toggle between your Workstation (i.e., test) and Production (i.e., live) versions by clicking the environment label in the header of the Recipe editor.

A Buildable developer toggling between Workstation and live environments

For safety reasons, you cannot make edits directly to a Production Recipe. To make changes in Production, you need to switch to the Recipe's Workstation mode, make your changes and deploy again.