cdk-diff-summary 1.1.1__tar.gz

cdk_diff_summary-1.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cdk-diff-summary contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cdk_diff_summary-1.1.1/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: cdk-diff-summary
+Version: 1.1.1
+Summary: Summarize AWS CDK diff JSON as compact Markdown.
+Author: cdk-diff-summary contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jalcock501/cdk-diff-summary-pypi
+Project-URL: Repository, https://github.com/jalcock501/cdk-diff-summary-pypi
+Project-URL: Documentation, https://github.com/jalcock501/cdk-diff-summary-pypi#readme
+Project-URL: Issues, https://github.com/jalcock501/cdk-diff-summary-pypi/issues
+Keywords: aws,cdk,cloudformation,github-actions,diff
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build<2.0,>=1.2; extra == "dev"
+Requires-Dist: pytest<10.0,>=8.3; extra == "dev"
+Requires-Dist: ruff<0.16,>=0.8; extra == "dev"
+Requires-Dist: twine<7.0,>=5.0; extra == "dev"
+Dynamic: license-file
+
+# cdk-diff-summary
+
+`cdk-diff-summary` reads AWS CDK diff JSON and renders a compact Markdown summary.
+
+It is useful locally, in CI systems, and in GitHub Actions workflows where raw CDK or CloudFormation diffs are too noisy. It groups adds, modifies, removes, replacements, security group rule changes, and other changes while reducing common churn from IAM policy documents and CDK asset hashes.
+
+The tool deliberately shows changed field paths only, not before/after values, to avoid exposing sensitive infrastructure values in summaries.
+
+## Install
+
+```bash
+pipx install cdk-diff-summary
+```
+
+or:
+
+```bash
+python -m pip install cdk-diff-summary
+```
+
+## Usage
+
+Generate CDK diff JSON:
+
+```bash
+npx cdk diff --json > cdk-diff.json
+```
+
+Render Markdown to stdout:
+
+```bash
+cdk-diff-summary cdk-diff.json
+```
+
+Append Markdown to a file:
+
+```bash
+cdk-diff-summary cdk-diff.json --output cdk-diff-summary.md
+```
+
+Use a custom title and field limit:
+
+```bash
+cdk-diff-summary cdk-diff.json \
+  --title "Production CDK diff" \
+  --max-changed-fields 5
+```
+
+Fail when visible removals or replacements exist:
+
+```bash
+cdk-diff-summary cdk-diff.json --fail-on-remove --fail-on-replace
+```
+
+## CLI Options
+
+| Option | Description |
+| --- | --- |
+| `diff-json-path` | Path to JSON produced by `cdk diff --json`. May also be set with `DIFF_JSON_PATH`. |
+| `--title` | Markdown heading for the summary. Defaults to `CDK diff summary`. |
+| `--max-changed-fields` | Maximum changed field paths shown per resource. Defaults to `8`. |
+| `--collapse-iam-policies` / `--no-collapse-iam-policies` | Collapse large IAM policy document diffs to compact paths. Enabled by default. |
+| `--collapse-assets` / `--no-collapse-assets` | Collapse common CDK asset/hash churn. Enabled by default. |
+| `--fail-on-remove` | Write the summary, then exit non-zero if visible resource removes exist. |
+| `--fail-on-replace` | Write the summary, then exit non-zero if visible resource replacements exist. |
+| `--output` | Optional path to append the generated Markdown summary. |
+| `--github-step-summary` | Optional path to append GitHub Step Summary Markdown. Defaults to `$GITHUB_STEP_SUMMARY`. |
+
+Environment variables compatible with the GitHub Action wrapper are also supported:
+
+- `DIFF_JSON_PATH`
+- `SUMMARY_TITLE`
+- `MAX_CHANGED_FIELDS`
+- `COLLAPSE_IAM_POLICIES`
+- `COLLAPSE_ASSETS`
+- `FAIL_ON_REMOVE`
+- `FAIL_ON_REPLACE`
+- `SUMMARY_OUTPUT_PATH`
+- `GITHUB_STEP_SUMMARY`
+
+CLI arguments take precedence over environment variables.
+
+## Example Output
+
+```markdown
+## CDK diff summary
+
+| Metric | Count |
+| --- | ---: |
+| Stack changes | 1 |
+| Resource changes | 3 |
+| Adds | 1 |
+| Modifies | 1 |
+| Removes | 0 |
+| Replacements | 1 |
+| Security group changes | 1 |
+| Changes shown below | 4 |
+
+### Replacements
+
+| Stack | Logical ID | Action | Resource type | Changed fields |
+| --- | --- | --- | --- | --- |
+| PaymentsStack | Worker | replace | AWS::Lambda::Function | `Architectures[]`, `Layers[]` |
+
+### Security group changes
+
+| Stack | Security group | Direction | Protocol | Port | Action |
+| --- | --- | --- | --- | --- | --- |
+| PaymentsStack | AppSecurityGroup | ingress | tcp | 443 | add |
+```
+
+## Local Development
+
+```bash
+python -m pip install -e ".[dev]"
+python -m pytest
+ruff check .
+python -m build
+twine check dist/*
+```
+
+Run from source:
+
+```bash
+cdk-diff-summary example_cdk_diff_json/cdk-diff-json-tiny.json
+```
+
+## Publishing
+
+This package is ready for PyPI trusted publishing. Create a PyPI project named `cdk-diff-summary`, configure a trusted publisher for this repository and the `publish.yml` workflow, then create a GitHub release.
+
+For a manual dry run:
+
+```bash
+python -m build
+twine check dist/*
+```
+
+CDK diff JSON shape can vary by CDK version. If parsing fails, please open an issue with a sanitized example of the JSON shape that failed.

cdk_diff_summary-1.1.1/README.md

@@ -0,0 +1,139 @@
+# cdk-diff-summary
+
+`cdk-diff-summary` reads AWS CDK diff JSON and renders a compact Markdown summary.
+
+It is useful locally, in CI systems, and in GitHub Actions workflows where raw CDK or CloudFormation diffs are too noisy. It groups adds, modifies, removes, replacements, security group rule changes, and other changes while reducing common churn from IAM policy documents and CDK asset hashes.
+
+The tool deliberately shows changed field paths only, not before/after values, to avoid exposing sensitive infrastructure values in summaries.
+
+## Install
+
+```bash
+pipx install cdk-diff-summary
+```
+
+or:
+
+```bash
+python -m pip install cdk-diff-summary
+```
+
+## Usage
+
+Generate CDK diff JSON:
+
+```bash
+npx cdk diff --json > cdk-diff.json
+```
+
+Render Markdown to stdout:
+
+```bash
+cdk-diff-summary cdk-diff.json
+```
+
+Append Markdown to a file:
+
+```bash
+cdk-diff-summary cdk-diff.json --output cdk-diff-summary.md
+```
+
+Use a custom title and field limit:
+
+```bash
+cdk-diff-summary cdk-diff.json \
+  --title "Production CDK diff" \
+  --max-changed-fields 5
+```
+
+Fail when visible removals or replacements exist:
+
+```bash
+cdk-diff-summary cdk-diff.json --fail-on-remove --fail-on-replace
+```
+
+## CLI Options
+
+| Option | Description |
+| --- | --- |
+| `diff-json-path` | Path to JSON produced by `cdk diff --json`. May also be set with `DIFF_JSON_PATH`. |
+| `--title` | Markdown heading for the summary. Defaults to `CDK diff summary`. |
+| `--max-changed-fields` | Maximum changed field paths shown per resource. Defaults to `8`. |
+| `--collapse-iam-policies` / `--no-collapse-iam-policies` | Collapse large IAM policy document diffs to compact paths. Enabled by default. |
+| `--collapse-assets` / `--no-collapse-assets` | Collapse common CDK asset/hash churn. Enabled by default. |
+| `--fail-on-remove` | Write the summary, then exit non-zero if visible resource removes exist. |
+| `--fail-on-replace` | Write the summary, then exit non-zero if visible resource replacements exist. |
+| `--output` | Optional path to append the generated Markdown summary. |
+| `--github-step-summary` | Optional path to append GitHub Step Summary Markdown. Defaults to `$GITHUB_STEP_SUMMARY`. |
+
+Environment variables compatible with the GitHub Action wrapper are also supported:
+
+- `DIFF_JSON_PATH`
+- `SUMMARY_TITLE`
+- `MAX_CHANGED_FIELDS`
+- `COLLAPSE_IAM_POLICIES`
+- `COLLAPSE_ASSETS`
+- `FAIL_ON_REMOVE`
+- `FAIL_ON_REPLACE`
+- `SUMMARY_OUTPUT_PATH`
+- `GITHUB_STEP_SUMMARY`
+
+CLI arguments take precedence over environment variables.
+
+## Example Output
+
+```markdown
+## CDK diff summary
+
+| Metric | Count |
+| --- | ---: |
+| Stack changes | 1 |
+| Resource changes | 3 |
+| Adds | 1 |
+| Modifies | 1 |
+| Removes | 0 |
+| Replacements | 1 |
+| Security group changes | 1 |
+| Changes shown below | 4 |
+
+### Replacements
+
+| Stack | Logical ID | Action | Resource type | Changed fields |
+| --- | --- | --- | --- | --- |
+| PaymentsStack | Worker | replace | AWS::Lambda::Function | `Architectures[]`, `Layers[]` |
+
+### Security group changes
+
+| Stack | Security group | Direction | Protocol | Port | Action |
+| --- | --- | --- | --- | --- | --- |
+| PaymentsStack | AppSecurityGroup | ingress | tcp | 443 | add |
+```
+
+## Local Development
+
+```bash
+python -m pip install -e ".[dev]"
+python -m pytest
+ruff check .
+python -m build
+twine check dist/*
+```
+
+Run from source:
+
+```bash
+cdk-diff-summary example_cdk_diff_json/cdk-diff-json-tiny.json
+```
+
+## Publishing
+
+This package is ready for PyPI trusted publishing. Create a PyPI project named `cdk-diff-summary`, configure a trusted publisher for this repository and the `publish.yml` workflow, then create a GitHub release.
+
+For a manual dry run:
+
+```bash
+python -m build
+twine check dist/*
+```
+
+CDK diff JSON shape can vary by CDK version. If parsing fails, please open an issue with a sanitized example of the JSON shape that failed.

cdk_diff_summary-1.1.1/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cdk-diff-summary"
+version = "1.1.1"
+description = "Summarize AWS CDK diff JSON as compact Markdown."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "cdk-diff-summary contributors" }]
+keywords = ["aws", "cdk", "cloudformation", "github-actions", "diff"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Build Tools",
+  "Topic :: System :: Systems Administration",
+  "Typing :: Typed",
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2,<2.0",
+  "pytest>=8.3,<10.0",
+  "ruff>=0.8,<0.16",
+  "twine>=5.0,<7.0",
+]
+
+[project.scripts]
+cdk-diff-summary = "cdk_diff_summary.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/jalcock501/cdk-diff-summary-pypi"
+Repository = "https://github.com/jalcock501/cdk-diff-summary-pypi"
+Documentation = "https://github.com/jalcock501/cdk-diff-summary-pypi#readme"
+Issues = "https://github.com/jalcock501/cdk-diff-summary-pypi/issues"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+cdk_diff_summary = ["py.typed"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]

cdk_diff_summary-1.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cdk_diff_summary-1.1.1/src/cdk_diff_summary/__init__.py

@@ -0,0 +1,3 @@
+"""Summarize AWS CDK diff JSON as compact Markdown."""
+
+__version__ = "1.1.1"

cdk_diff_summary-1.1.1/src/cdk_diff_summary/cli.py

@@ -0,0 +1,167 @@
+"""Command-line interface for cdk-diff-summary."""
+
+from __future__ import annotations
+
+import argparse
+import json
+import sys
+from dataclasses import dataclass
+from os import environ
+from pathlib import Path
+from typing import TextIO
+
+from cdk_diff_summary.config import DEFAULT_TITLE, parse_bool, parse_max_changed_fields
+from cdk_diff_summary.diff import DiffSummary, parse_diff
+from cdk_diff_summary.render import render_summary
+
+
+@dataclass(frozen=True)
+class CliConfig:
+    diff_json_path: str
+    title: str
+    max_changed_fields: int
+    collapse_iam_policies: bool
+    collapse_assets: bool
+    fail_on_remove: bool
+    fail_on_replace: bool
+    output_path: str
+    github_step_summary: str
+
+
+def main(argv: list[str] | None = None) -> int:
+    try:
+        config = parse_args(argv)
+        diff_summary = parse_diff_from_file(config)
+        markdown = render_summary(
+            diff_summary,
+            title=config.title,
+            max_changed_fields=config.max_changed_fields,
+        )
+        append_outputs(config, markdown)
+        return fail_status(config, diff_summary)
+    except (OSError, ValueError, json.JSONDecodeError) as exc:
+        print(f"cdk-diff-summary: {exc}", file=sys.stderr)
+        return 1
+
+
+def parse_args(argv: list[str] | None = None) -> CliConfig:
+    parser = argparse.ArgumentParser(
+        description="Render a compact Markdown summary from AWS CDK diff JSON.",
+    )
+    parser.add_argument(
+        "diff_json_path",
+        nargs="?",
+        help="Path to JSON produced by cdk diff --json. Defaults to DIFF_JSON_PATH.",
+    )
+    parser.add_argument(
+        "--title",
+        default=environ.get("SUMMARY_TITLE", DEFAULT_TITLE) or DEFAULT_TITLE,
+        help="Markdown heading for the summary.",
+    )
+    parser.add_argument(
+        "--max-changed-fields",
+        default=environ.get("MAX_CHANGED_FIELDS", "8"),
+        help="Maximum changed field paths to show for each resource.",
+    )
+    parser.add_argument(
+        "--collapse-iam-policies",
+        action=argparse.BooleanOptionalAction,
+        default=parse_bool(environ.get("COLLAPSE_IAM_POLICIES"), default=True),
+        help="Collapse IAM policy document changes. Enabled by default.",
+    )
+    parser.add_argument(
+        "--collapse-assets",
+        action=argparse.BooleanOptionalAction,
+        default=parse_bool(environ.get("COLLAPSE_ASSETS"), default=True),
+        help="Collapse common CDK asset/hash churn. Enabled by default.",
+    )
+    parser.add_argument(
+        "--fail-on-remove",
+        action="store_true",
+        default=parse_bool(environ.get("FAIL_ON_REMOVE"), default=False),
+        help="Exit non-zero after writing the summary if visible removes exist.",
+    )
+    parser.add_argument(
+        "--fail-on-replace",
+        action="store_true",
+        default=parse_bool(environ.get("FAIL_ON_REPLACE"), default=False),
+        help="Exit non-zero after writing the summary if visible replacements exist.",
+    )
+    parser.add_argument(
+        "--output",
+        default=environ.get("SUMMARY_OUTPUT_PATH", "").strip(),
+        help="Optional path to append the generated Markdown summary.",
+    )
+    parser.add_argument(
+        "--github-step-summary",
+        default=environ.get("GITHUB_STEP_SUMMARY", "").strip(),
+        help="Optional path to append GitHub Step Summary Markdown.",
+    )
+
+    args = parser.parse_args(argv)
+    diff_json_path = args.diff_json_path or environ.get("DIFF_JSON_PATH", "").strip()
+    if not diff_json_path:
+        raise ValueError("diff-json-path argument or DIFF_JSON_PATH is required")
+
+    return CliConfig(
+        diff_json_path=diff_json_path,
+        title=args.title,
+        max_changed_fields=parse_max_changed_fields(str(args.max_changed_fields)),
+        collapse_iam_policies=args.collapse_iam_policies,
+        collapse_assets=args.collapse_assets,
+        fail_on_remove=args.fail_on_remove,
+        fail_on_replace=args.fail_on_replace,
+        output_path=args.output,
+        github_step_summary=args.github_step_summary,
+    )
+
+
+def parse_diff_from_file(config: CliConfig) -> DiffSummary:
+    with Path(config.diff_json_path).open(encoding="utf-8") as handle:
+        document = json.load(handle)
+    return parse_diff(
+        document,
+        collapse_iam_policies=config.collapse_iam_policies,
+        collapse_assets=config.collapse_assets,
+    )
+
+
+def append_outputs(config: CliConfig, markdown: str) -> None:
+    if config.github_step_summary:
+        append_file(Path(config.github_step_summary), markdown)
+    if config.output_path:
+        append_file(Path(config.output_path), markdown)
+    if not config.github_step_summary and not config.output_path:
+        sys.stdout.write(markdown)
+
+
+def append_file(path: Path, markdown: str) -> None:
+    path.parent.mkdir(parents=True, exist_ok=True)
+    with path.open("a", encoding="utf-8") as handle:
+        append_markdown(handle, markdown)
+
+
+def append_markdown(handle: TextIO, markdown: str) -> None:
+    handle.write(markdown)
+    if not markdown.endswith("\n"):
+        handle.write("\n")
+
+
+def fail_status(config: CliConfig, diff_summary: DiffSummary) -> int:
+    if config.fail_on_remove and diff_summary.removes > 0:
+        print(
+            "cdk-diff-summary: visible removes found and --fail-on-remove is set",
+            file=sys.stderr,
+        )
+        return 2
+    if config.fail_on_replace and diff_summary.replacements > 0:
+        print(
+            "cdk-diff-summary: visible replacements found and --fail-on-replace is set",
+            file=sys.stderr,
+        )
+        return 3
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

cdk_diff_summary-1.1.1/src/cdk_diff_summary/config.py

@@ -0,0 +1,64 @@
+"""Runtime configuration for the cdk-diff-summary action."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from os import environ
+
+DEFAULT_TITLE = "CDK diff summary"
+TRUE_VALUES = {"1", "true", "yes", "y", "on"}
+FALSE_VALUES = {"0", "false", "no", "n", "off", ""}
+
+
+@dataclass(frozen=True)
+class Config:
+    diff_json_path: str
+    summary_title: str
+    max_changed_fields: int
+    collapse_iam_policies: bool
+    collapse_assets: bool
+    fail_on_remove: bool
+    fail_on_replace: bool
+    summary_output_path: str
+    github_step_summary: str
+
+
+def parse_bool(value: str | None, *, default: bool = False) -> bool:
+    if value is None:
+        return default
+    normalized = value.strip().lower()
+    if normalized in TRUE_VALUES:
+        return True
+    if normalized in FALSE_VALUES:
+        return False
+    raise ValueError(f"expected a boolean value, got {value!r}")
+
+
+def parse_max_changed_fields(value: str | None) -> int:
+    raw_value = "8" if value is None or value.strip() == "" else value.strip()
+    try:
+        parsed = int(raw_value)
+    except ValueError as exc:
+        message = "MAX_CHANGED_FIELDS must be an integer greater than or equal to 1"
+        raise ValueError(message) from exc
+    if parsed < 1:
+        raise ValueError("MAX_CHANGED_FIELDS must be greater than or equal to 1")
+    return parsed
+
+
+def load_config() -> Config:
+    diff_json_path = environ.get("DIFF_JSON_PATH", "").strip()
+    if not diff_json_path:
+        raise ValueError("DIFF_JSON_PATH is required")
+
+    return Config(
+        diff_json_path=diff_json_path,
+        summary_title=environ.get("SUMMARY_TITLE", DEFAULT_TITLE) or DEFAULT_TITLE,
+        max_changed_fields=parse_max_changed_fields(environ.get("MAX_CHANGED_FIELDS")),
+        collapse_iam_policies=parse_bool(environ.get("COLLAPSE_IAM_POLICIES"), default=True),
+        collapse_assets=parse_bool(environ.get("COLLAPSE_ASSETS"), default=True),
+        fail_on_remove=parse_bool(environ.get("FAIL_ON_REMOVE"), default=False),
+        fail_on_replace=parse_bool(environ.get("FAIL_ON_REPLACE"), default=False),
+        summary_output_path=environ.get("SUMMARY_OUTPUT_PATH", "").strip(),
+        github_step_summary=environ.get("GITHUB_STEP_SUMMARY", "").strip(),
+    )