@salesforce/b2c-tooling-sdk / openshell / ApplyOpenShellSetupOptions
Interface: ApplyOpenShellSetupOptions
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:234
Options for applyOpenShellSetup.
Extends
Properties
build?
optionalbuild:boolean
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:238
Build the image when it is missing (default true)
dockerfile
dockerfile:
string
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:83
Dockerfile content used when the image must be built
Inherited from
OpenShellApplyOptions.dockerfile
image
image:
string
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:81
Container image for the sandbox
Inherited from
onEnvironmentChanged()?
optionalonEnvironmentChanged: (names) =>void
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:250
Called when an existing sandbox is updated but its environment variables (such as SFCC_SAFETY_LEVEL) differ from the setup. They apply only when the sandbox is recreated.
Parameters
names
string[]
Returns
void
onStep()?
optionalonStep: (step) =>void
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:244
Called before each step runs
Parameters
step
Returns
void
recreate?
optionalrecreate:boolean
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:242
Delete and recreate an existing sandbox (to apply provider or environment changes)
run?
optionalrun:CommandRunner
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:252
Command runner (for testing)
sandbox?
optionalsandbox:boolean
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:240
Create the sandbox, or update the policy of an existing one (default true)
secrets
secrets:
Record<string,string|undefined>
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:236
Secret values keyed by environment variable name (e.g. SFCC_CLIENT_SECRET)