v0.2.0

Features

• Added in the output for the cdk.log output path defined in actions.yml.

Docs

• Small cleanup and example pr comment added.

v0.1.0

Key Features

• Automated Diff Summary: Runs cdk diff for pull requests and provides a readable summary.
• Clean and Clear Output: Formats the cdk diff output in Markdown for better readability.
• Enhanced Review Process: Posts the diff summary directly on pull requests for easy access.
• Detection of Critical Changes: Highlights significant changes and potential risks.
• Efficient Output Management: Ensures the comment size is within GitHub's constraints.

How It Works

The action comprises several key functions:

1. Reading and Cleaning Output: Reads the cdk diff output file, cleans it of ANSI escape codes, and converts it into a Markdown-friendly format.
2. Processing Differences: Identifies the number of stacks with differences and resources requiring replacement, providing a concise summary at the top of the comment.
3. Commenting on Pull Requests: Utilizes the GitHub API to post the processed cdk diff output as a comment on the relevant pull request.

Usage

Refer to the actions.ymlfor detailed configuration options.

Basic Configuration

- uses: daveved/cdk-diff-action@v0.1.0
  with:
    repo-token: ${{ secrets.GITHUB_TOKEN }}