[NEW EXAMPLE] AWS CDK - Diff computation

[ainzzorl]

General

• Project name: AWS CDK
• Example name: Compute diff between infrastructure templates
• Project home page: https://github.com/aws/aws-cdk
• Programming language(s): Typescript
• Frameworks, libraries used: AWS, CloudFormation

Description

AWS CDK is an infrastructure-as-code tool. When updating infrastructure, it needs to compute semantic diff between infrastructure templates. The algorithm is rather straightforward.

Links

• Package
• Main
• Test

What makes it interesting

• Computing meaningful diffs is a rather common problem.
• Testing is exemplary.

Other

N/A

[ainzzorl]

Draft: https://github.com/ainzzorl/goodcode/blob/4f5b4e11c240077fcfbe8a6223e199178eedf292/articles/aws-cdk-template-diff.md

[ainzzorl]

Before publishing:

• Remove "Give a high-level description of the project. Explain the part(s) of it that include the example in more detail."
• "The diff can be visualized." - maybe "There's a method to print the diff in a human-readable format"?
• Main method - explain about the convergence. And in general how it works, it's not obviously clear.
• "Diffing templates (without propagation)" - mention DIFF_HANDLERS doing the heavy lifting.
• Add observations or remove.
• Note that some resource types require special treatment (network, IAM).
• Mention impact types.
• Mention that we are just scratching the surface here.

[ainzzorl]

Updated and set the status to PUBLISHED. It is still one of the weaker articles, though. Some explanations are lacking.