ArchitectureDiffReporter

Renders an ArchitectureDiff as a pull-request comment.

Architecture changes are invisible in a normal diff: adding one line to a dependencies { } block can wire two subsystems together, and the review shows one line. This turns that into a paragraph a reviewer reads without knowing the graph.

Ordered by consequence rather than by kind - a new cycle first, then dependencies, then modules - because a reviewer skims from the top and the first thing they see should be the thing most worth their attention.

Functions

Link copied to clipboard

The diff as machine-readable JSON, for a CI job that wants to gate on it.

Link copied to clipboard
fun markdown(diff: ArchitectureDiff, projectName: String): String

The diff as a Markdown document, ready to post as a pull-request comment.