Skip to content

Commit

Permalink
docs: add migration tips
Browse files Browse the repository at this point in the history
  • Loading branch information
aripalo committed Nov 25, 2024
1 parent c352856 commit 0fcd5b8
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,11 @@ To upgrade to stable major version 1, run:
npm i -D @alma-cdk/project@1
```

No other source code changes are required and no CloudFormation diff will be caused by this upgrade, with the exception of how you want to control the tagging behavior (see below):
No other source code changes are required and no CloudFormation diff will be caused by this upgrade, with the exception of how you want to control the [tagging behavior changes](#v0-to-v1-tagging-behavior-changes).

> [!Tip]
> It's recommended to run `cdk diff` against your existing CDK stacks to verify the effects of the upgrade (instead of blindly deploying).


### v0 to v1 Tagging behavior changes

Expand Down

0 comments on commit 0fcd5b8

Please sign in to comment.