Granular Deployment in Test & Deploy

Granular deployment allows you to test and deploy individual changes within an Application and dependent Applications, rather than deploying all changes at once. This gives you more control and flexibility, so you can choose exactly which changes to move to the target environment.

This article covers granular deployment, including how it works, how to manage deployments, and its impact on environments.

🛡️Warning

Full deployment is unavailable when granular deployment is turned on in an environment.

For more information on Test & Deploy, including how it works and how environments are structured, see Introduction to Test & Deploy.

Access rights and permissions

You must have the following rights and permissions to use granular deployment:

• You have equivalent permissions in both the source and target environments.

• You have access to all Applications involved in the deployment (both deploying and receiving changes).

Deployment options

Test & Deploy supported two deployment options:

• Full deployment. Deployed all changes across all Applications in the Workspace from a source to a target environment.

• Partial deployment. Deployed changes from selected Applications, along with their dependencies, from a source to a target environment.

Granular deployment introduces a new deployment option, giving you more control over what is deployed between your environments.

What is granular deployment?

Granular deployment allows you to deploy specific selected changes without deploying an entire Workspace or Application. It provides more precision and control when deciding what to move from a source to a target environment.

You can access deployment options from the top-right corner of your Dev or Test environment.

⚠️ Important

Deleted Applications can be included in either deployment option but only for full deployment.

The following options are available:

• Deploy entire Applications. Choose one or more Applications to deploy.

• Deploy granular changes. Choose specific changes for a more detailed, granular deployment.

⚠️ Important

Deploying from within an Application or from the Application menu always opens the granular deployment option.

Full Application deployment is only available from the New deployment button on the Workspace homepage.

Manage dependencies in granular deployment

With full and partial deployment in Test & Deploy, changes were deployed at the Application level. If a change depended on elements in another Application, those Applications had to be deployed together.

Granular deployment introduces change-level selection. No changes are selected by default. You review detected structural changes and explicitly choose which ones to deploy. If a selected change has dependencies, they are clearly indicated by required or optional labels:

• Required. These changes are strictly required for the deployment. Required dependencies are automatically included and cannot be removed. Dependencies from other Applications are included only when necessary. Unrelated changes remain excluded.

• Optional. These changes are not strictly required for the deployment but are automatically selected and can be deselected.

If you remove a selected change with Optional dependencies, its associated dependencies are updated accordingly.

This allows you to deploy a single structural update, such as a Metric, Dimension, or List Property, without deploying other in-progress changes in the same Application, while ensuring the deployment remains valid even for cross-Application dependencies.

Run a granular deployment

To start a granular deployment:

1. On the Workspace homepage, select New deployment

2. Choose Deploy granular changes.

   1. (Optional) You can select Deploy changes Source → Target to deploy changes from the Application menu.

3. In the Start a new deployment panel, select the Applications with changes you want to deploy from the drop-down menu. Dependencies are automatically included.

4. (Optional) Turn on Add deleted Applications to the scope to include deleted Applications alongside granular changes. Deleted Applications are always deployed in full.

5. (Optional) Turn on Include Workspace settings to the scope to include User Groups in the deployment.

   User Groups can only be deployed using a granular deployment.

6. Select Next step: Review changes. This takes you to the New deployment page.

From the New deployment page:

1. From the sidebar, select the Application containing changes to deploy under Selected scope.

ℹ️ Note

Before granular deployment, the Diff screen automatically displayed changes to Applications in the Workspace, including updates, removals, creations, and their dependencies. The Diff screen now remains empty until you select the changes you want to deploy.

2. Select Add changes, followed by Review & select changes.

3. Use the filters to search for a change or filter changes by type, Boards & Sequences, Blocks, or review them manually.

4. Select a change to open the Change details panel, where you can view information about the individual change, including any required or optional dependencies.

5. (Optional) If dependencies are listed, select Show changes to expand them. Select a dependency name to view its details in its associated Application.

6. Toggle any change to On to select specific changes to deploy to the target environment.

7. Select Add selected changes or Cancel to return to the previous screen.

8. From the Changes to deploy screen, select Deploy X changes to deploy selected changes or select + Add changes to review and add more changes to the scope.

9. In the Summary panel, add a name and description for the deployment and review the deployment scope.

10. Select Deploy then select one of the following options to complete the deployment:

    2. Lock all Applications. Select this option to lock all managed Applications in your source and target environments. This is the most secure way to ensure that no changes can affect the deployment.

    3. Lock X Application. Select this option to lock only the deployed Applications in your source and target environments. This flexible option increases the risk of deployment failure if another Member uses or updates shared Blocks from an unlocked Application during the deployment process.

Manage deployments

Members who have deployment notifications enabled are notified once the deployment is complete. Notifications can be sent for the source environment, the target environment, or both, depending on individual settings.

ℹ️ Note

If you have feedback or experience any issues, please contact our Support team.

To manage your organisation’s deployments, go to the Production Workspace homepage and select Deployments.

This page lists all deployments, including:

• A summary of the deployment

• Deployment scope (local, environment or data refresh)

  ℹ️ Note

  To perform a data refresh, please contact our Support team.

• Number of changes and applications affected

• Required follow-up actions

• Deployment status and progress

• Deployment date and time

• The Member who deployed the changes

Notifications

Email and Slack deployment notifications are turned off by default and can be enabled individually.

To enable deployment notifications:

1. Go to Account Settings

2. Select Deployments under Notifications

These notifications are separate from Application notifications, which can be enabled by selecting Workspace & Application operations on the same page in each environment.

Members with deployment notifications enabled receive a notification once a deployment is complete. Notifications can be configured for:

• The source environment

• The target environment

• All environments

Pigment Features supported in granular deployment

Granular deployment supports most Pigment features, with the exception of Scenarios and Integrations. If you notice any issues or have feedback, please contact our Support team.