AWS CDK Diff GitHub Action

Start here to understand the AWS CDK Diff GitHub Action, why teams adopt it, and where to go next.

Overview

The AWS CDK Diff GitHub Action automatically posts formatted CDK diff output as comments on Pull Requests. Use it to review infrastructure changes directly within your PR workflow, making it easier to catch potential issues before deploying CDK changes to production.

Why teams choose it

  • Automatic PR comments with formatted CDK diff output so your team sees infrastructure changes immediately
  • Smart comment updates that refresh existing comments instead of creating duplicates
  • Intelligent parsing that highlights IAM statement changes, Security Group rules, Parameters, and Resources
  • Built with native JavaScript for fast execution compared to Docker-based alternatives
  • Skips posting when there are no changes to keep your PR conversations clean

What's inside

  • Automatic CDK diff parsing and formatting for readable PR comments
  • Support for multiple stacks in a single diff output
  • Custom headers for organizing multi-environment setups
  • Configurable AWS region display in comments
  • Outputs for integration with other workflow steps

Who is this for

Development teams using AWS CDK who want to review infrastructure changes directly in their Pull Request workflow instead of checking pipeline logs or running diffs locally.

What you'll learn

Documentation map

Install

Get started with prerequisites, basic setup, and your first diff comment. Includes best practices for security, performance, maintenance, and comprehensive troubleshooting.

Usage Examples

Explore practical examples covering:

  • Complete workflow for posting CDK diffs
  • Reusable workflows for DRY patterns

Configuration

Complete reference for all available inputs and outputs the action accepts.

Ready to get hands-on? Head straight to the Install guide to add the action to your workflow, then explore Usage Examples for advanced patterns.

Resources

← Install CloudBurnInstall →