AtomicDeployPlan
Defined in: src/sync/createAtomicDeployPlan.ts:61
Result returned by createAtomicDeployPlan.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
activate | AtomicDeployActivateStep[] | Activation steps that swap staging into the live path. | src/sync/createAtomicDeployPlan.ts:81 |
backupPath? | string | Optional backup path used by the rename strategy. | src/sync/createAtomicDeployPlan.ts:77 |
createdAt | Date | Time the plan was created. | src/sync/createAtomicDeployPlan.ts:87 |
id | string | Stable plan identifier. | src/sync/createAtomicDeployPlan.ts:63 |
livePath | string | Live target path the release activates onto. | src/sync/createAtomicDeployPlan.ts:71 |
metadata? | Record<string, unknown> | Caller-defined metadata retained for diagnostics. | src/sync/createAtomicDeployPlan.ts:91 |
provider? | ProviderId | Provider identifier for the live destination when known. | src/sync/createAtomicDeployPlan.ts:69 |
prune | AtomicDeployPruneStep[] | Prune steps that remove older releases beyond retain. | src/sync/createAtomicDeployPlan.ts:83 |
releaseId | string | Release identifier embedded into the staging path. | src/sync/createAtomicDeployPlan.ts:65 |
releasesRoot | string | Releases root directory under which staging and prior releases live. | src/sync/createAtomicDeployPlan.ts:75 |
retain | number | Number of releases to retain (including the new release). | src/sync/createAtomicDeployPlan.ts:85 |
stagingPath | string | Staging directory the upload populates. | src/sync/createAtomicDeployPlan.ts:73 |
strategy | AtomicDeployStrategy | Activation strategy chosen for the swap. | src/sync/createAtomicDeployPlan.ts:67 |
uploadPlan | TransferPlan | Upload plan that populates the staging directory. | src/sync/createAtomicDeployPlan.ts:79 |
warnings | string[] | Non-fatal plan warnings. | src/sync/createAtomicDeployPlan.ts:89 |