@salesforce/b2c-tooling-sdk / operations/code / findAndDeployCartridges

Function: findAndDeployCartridges()

findAndDeployCartridges(instance, directory, options): Promise<DeployResult>

Defined in: packages/b2c-tooling-sdk/src/operations/code/deploy.ts:231

Finds and deploys cartridges from a directory to an instance.

This is a high-level function that orchestrates the deployment process:

1. Finds cartridges in the specified directory (by .project files)
2. Applies include/exclude filters
3. Optionally deletes existing cartridges first
4. Creates a zip archive and uploads via WebDAV
5. Optionally reloads the code version

Requires instance.config.codeVersion to be set.

Parameters

instance

B2CInstance

B2C instance to deploy to (must have codeVersion set)

directory

string

Directory to search for cartridges

options

DeployOptions = {}

Deploy options (filters, reload, delete)

Returns

Promise<DeployResult>

Deploy result with cartridges and status

Throws

Error if code version not set, no cartridges found, or deployment fails

Example

// Simple deploy
const result = await findAndDeployCartridges(instance, './cartridges');

// Deploy specific cartridges with reload
const result = await findAndDeployCartridges(instance, '.', {
  include: ['app_storefront_base'],
  reload: true,
});

// Delete existing cartridges before upload
const result = await findAndDeployCartridges(instance, './cartridges', {
  delete: true,
  reload: true,
});