Managing your bundles

Last updatedView as Markdown

Use the Deployer’s Bundles page to manage and deploy code changes for your site.

A bundle in PageBuilder Editor is a .zip file that contains the code, node modules, and environment configurations needed to run your website.

The Deployer’s Bundle page helps you upload and preview several bundles before making them live. This allows you to identify errors and make necessary changes before deploying them to your Production environment.

Bundles have three main statuses:

  • Unused - defines an uploaded bundle that you still need to deploy.
  • Deployed - defines a server-deployed bundle, allowing you to test how it looks and behaves before promoting it to live.
  • Live - defines your website’s active version, which receives user traffic.

Prerequisites

You must create a bundle—a .zip file containing all the code needed to run your website—before you can upload it using the Deployer’s Bundle page. See Build a bundle locally for more details.

Scenario: Deploying custom components

As a developer for a news organization, you want to deploy a new bundle containing custom components into your Production environment. To do so, you create a .zip file—or bundle—of your code locally and then access PageBuilder Editor > Developer Tools > Deployer.

You upload your bundle and give it a descriptive name. This process allows you to deploy your custom components efficiently, ensuring your editorial team can access the new blocks after they’re deployed.

Using the Deployer tool, you can also track all your bundle versions and control when they become available in your Production environment. In case you experience any issues with the active bundle, you can easily roll back to a previous working version of your website.

Procedures

Uploading your bundle

Follow these steps to upload a bundle:

  1. Navigate to the PageBuilder Editor > Developer Tools > Deployer. The Deployer page displays all running bundles and bundles uploaded in the previous 90 days.
  2. Click Upload Bundle to open the Upload Bundle window.
  3. Enter a descriptive Bundle Name that clearly distinguishes your bundle from others.
  4. Click icon_upload_bundle.pngUpload Bundle to select the .zip file from your system’s file browser.
  5. Click Upload Bundle.

Your bundle now appears on the main Deployer page, ready for deployment.

Deploying your bundle

Deploying your bundle allows you to preview how your feature and components behave in different environments, but does not make the changes available in your website. Follow these steps to deploy a bundle:

  1. Navigate to the PageBuilder Editor > Developer Tools > Deployer. The Deployer page displays all running bundles and bundles uploaded in the previous 90 days.
  2. Click icon_ellipsis.png next to your desired bundle > Deploy to open the Deploy Bundle window.
  3. Select the PageBuilder Engine version you want to use to deploy your bundle from the drop-down list.
  4. Click Deploy.

Your deployed bundle is available in the Running section of the Bundles page.

Previewing your bundle

Preview how your bundle renders before promoting it by following these steps:

  1. Navigate to the PageBuilder Editor > Developer Tools > Deployer. The Deployer page displays all running bundles and bundles uploaded in the previous 90 days.
  2. Click icon_ellipsis.png next to your desired bundle > Preview. This opens your bundle in a new window.
  3. After reviewing your code changes, click Back to deployer in the top right corner to return to the Deployer page.

Promoting your bundle

Deploying your bundle does not make it live or available to your end users; you must promote your bundle to do so. Follow these steps to promote your bundle to live status:

  1. Navigate to the PageBuilder Editor > Developer Tools > Deployer. The Deployer page displays all running bundles and bundles uploaded in the previous 90 days.
  2. Click icon_ellipsis.png next to your desired bundle > Promote to open the Promote Deployment window.
  3. Click Promote.

A green Live indicator appears next to your running bundle, confirming it’s now active on your site.

Terminating a bundle

If your bundle gets stuck during deployment, terminate it by following these steps:

  1. Navigate to the PageBuilder Editor > Developer Tools > Deployer. The Deployer page displays all running bundles and bundles uploaded in the previous 90 days.
  2. Click icon_ellipsis.png next to your desired bundle > Terminate to open the Terminate Deployment window.
  3. Click Terminate to confirm.