CreateAtomicDeployPlanOptions
Defined in: src/sync/createAtomicDeployPlan.ts:95
Options accepted by createAtomicDeployPlan.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
destination | SyncEndpointInput | Live destination endpoint the release activates onto. | src/sync/createAtomicDeployPlan.ts:103 |
diff | RemoteTreeDiff | Diff describing source vs. staging contents (typically diffed against an empty staging directory). | src/sync/createAtomicDeployPlan.ts:99 |
dryRun? | boolean | Whether the plan is informational only. Defaults to true. | src/sync/createAtomicDeployPlan.ts:115 |
existingReleases? | string[] | Existing release directory paths under the releases root that may be pruned. | src/sync/createAtomicDeployPlan.ts:113 |
id | string | Stable plan identifier. | src/sync/createAtomicDeployPlan.ts:97 |
metadata? | Record<string, unknown> | Caller-defined metadata retained for diagnostics. | src/sync/createAtomicDeployPlan.ts:119 |
now? | () => Date | Clock used for deterministic tests. Defaults to new Date(). | src/sync/createAtomicDeployPlan.ts:117 |
releaseId? | string | Release identifier. Defaults to a timestamp derived from now. | src/sync/createAtomicDeployPlan.ts:107 |
releasesDirectory? | string | Releases directory name under the destination root. Defaults to ".releases". | src/sync/createAtomicDeployPlan.ts:109 |
retain? | number | Number of releases to retain after the new release, including the new one. Defaults to 3. | src/sync/createAtomicDeployPlan.ts:111 |
source | SyncEndpointInput | Source-side endpoint feeding the release. | src/sync/createAtomicDeployPlan.ts:101 |
strategy? | AtomicDeployStrategy | Activation strategy. Defaults to "rename". | src/sync/createAtomicDeployPlan.ts:105 |