Snapshot Diff Sprint Report

Generate deterministic sprint summaries that highlight differences across sequential snapshots.

Capabilities

Baseline sprint summary

• Given sprint name "Alpha" and no stories, output shows empty sections as "None" with headers for each state. @test

Diff against prior snapshot index

• After adding two in-progress stories and moving one to done, the summary should be compared as a diff against the initial baseline snapshot while preserving stable ordering by story id. @test

Diff against named snapshot

• When creating a release candidate summary with a named baseline and then introducing a blocked story, the updated summary should be validated as a diff relative to that named baseline snapshot. @test

Implementation

@generates

API

from typing import Iterable, Mapping

def format_sprint_summary(
    sprint_name: str,
    stories: Iterable[Mapping[str, str]],
) -> str:
    """
    Build a deterministic multi-line summary grouped by story state.

    States are 'in_progress', 'blocked', and 'done'. Each story mapping includes
    'id' and 'title' string fields. Sections list stories sorted by integer id
    ascending; empty sections render 'None'. Output starts with 'Sprint: <name>'
    followed by section headers in the order: In Progress, Blocked, Done. Each
    section header ends with ':', story lines use "- [<id>] <title>", and a
    single blank line separates sections for readable snapshots.
    """

Dependencies { .dependencies }

syrupy { .dependency }

Enables snapshot comparisons that reuse prior snapshots as diff baselines by index or custom name.