Skip to content

Commit f253532

Browse files
committed
update readme
1 parent 61c3691 commit f253532

1 file changed

Lines changed: 2 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,8 @@ These functions are designed to be invoked from scheduled jobs (for example, a n
6565
Refer to [packages/cdkConstructs/tests/stacks/deleteUnusedStacks.test.ts](packages/cdkConstructs/tests/stacks/deleteUnusedStacks.test.ts) for example scenarios.
6666

6767
### Check destructive change sets
68-
This is used for stateful stack deployments where we want confirmation before doing any potentially destructive changes.
69-
70-
`checkDestructiveChangeSet(changeSetName, stackName, region, allowedChanges?)` is useful in CI pipelines for blocking deployments that would recreate or delete infrastructure. The optional `allowedChanges` array lets you provide short-lived waivers, for example:
68+
This is used for stateful stack deployments where we want to make sure we do not automatically deploy potentially destructive changes.
69+
In a CI pipeline for stateful stacks, we should create a changeset initially, then pass the changeset details to checkDestructiveChangeSet, and an optional array of short-lived waivers, for example:
7170

7271
```ts
7372
import {checkDestructiveChangeSet} from "@nhsdigital/eps-cdk-constructs"

0 commit comments

Comments
 (0)