@salesforce/b2c-tooling-sdk / openshell / ApplyOpenShellSetupOptions
Interface: ApplyOpenShellSetupOptions
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:202
Options for applyOpenShellSetup.
Extends
Properties
build?
optionalbuild:boolean
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:206
Build the image when it is missing (default true)
dockerfile
dockerfile:
string
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:62
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:60
Container image for the sandbox
Inherited from
onStep()?
optionalonStep: (step) =>void
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:212
Called before each step runs
Parameters
step
Returns
void
recreate?
optionalrecreate:boolean
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:210
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:214
Command runner (for testing)
sandbox?
optionalsandbox:boolean
Defined in: packages/b2c-tooling-sdk/src/openshell/apply.ts:208
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:204
Secret values keyed by environment variable name (e.g. SFCC_CLIENT_SECRET)