feat(change): add diff review artifacts #303

Closed
opened 2026-02-22 23:41:06 +00:00 by freemo · 1 comment
Owner

Metadata

  • Commit Message: feat(change): add diff review artifacts
  • Branch: feature/m3-diff-review

Background

DiffBuilder and ReviewArtifact models support CLI review with multi-resource diffs and per-resource grouping. Diff output serializers produce rich, plain, and JSON formatted output.

Acceptance Criteria

  • Implement DiffBuilder and ReviewArtifact models for CLI review.
  • Add support for multi-resource diffs and per-resource grouping.
  • Add diff output serializers for rich/plain/json formats.
  • Include before/after content hashes and file modes in diff metadata for integrity checks.
  • Detect binary files and include a binary marker instead of inline diff content.

Definition of Done

This issue is complete when:

  • All subtasks below are completed and checked off.
  • A Git commit is created where the first line of the commit message matches
    the Commit Message in Metadata exactly, followed by a blank line, then
    additional lines providing relevant details about the implementation. The
    commit body should be appropriate in size for a commit message and relatively
    complete in describing what was done.
  • The commit is pushed to the remote on the branch matching the Branch in
    Metadata exactly.
  • The commit is submitted as a pull request to master, reviewed, and
    merged before this issue is marked done.

Subtasks

  • Implement DiffBuilder and ReviewArtifact models for CLI review.
  • Add support for multi-resource diffs and per-resource grouping.
  • Add diff output serializers for rich/plain/json formats.
  • Include before/after content hashes and file modes in diff metadata for integrity checks.
  • Detect binary files and include a binary marker instead of inline diff content.
  • Add rename/move detection using path similarity + content hash and render as rename events.
  • Add max diff size guard with truncation notes and a truncated=true flag in JSON output.
  • Ensure diff output ordering is stable (resource name, path, change type).
  • Add docs/reference/diff_review.md with output format.
  • Tests (Behave): Add features/diff_review.feature for diff generation.
  • Tests (Robot): Add robot/diff_review.robot for review artifacts.
  • Tests (ASV): Add benchmarks/diff_review_bench.py for diff building performance.
  • Verify coverage >=97% via nox -s coverage_report. If coverage is <97% then review the current unit test coverage report at build/coverage.xml and use it to write new Behave based unit tests to improve code coverage. Specifically, write Behave style unit tests that are descriptively named and specifically improves coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun nox -s coverage_report to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.
  • Run nox (all default sessions, including benchmark), fix any errors if needed ensuring nox passes across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Section: ### Section 5: Actors, Skills & Tool Execution [WORKSTREAM C - Aditya Lead]
Status: Open

## Metadata - **Commit Message**: `feat(change): add diff review artifacts` - **Branch**: `feature/m3-diff-review` ## Background DiffBuilder and ReviewArtifact models support CLI review with multi-resource diffs and per-resource grouping. Diff output serializers produce rich, plain, and JSON formatted output. ## Acceptance Criteria - [ ] Implement DiffBuilder and ReviewArtifact models for CLI review. - [ ] Add support for multi-resource diffs and per-resource grouping. - [ ] Add diff output serializers for rich/plain/json formats. - [ ] Include before/after content hashes and file modes in diff metadata for integrity checks. - [ ] Detect binary files and include a binary marker instead of inline diff content. ## Definition of Done This issue is complete when: - All subtasks below are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. The commit body should be appropriate in size for a commit message and relatively complete in describing what was done. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done. ## Subtasks - [ ] Implement DiffBuilder and ReviewArtifact models for CLI review. - [ ] Add support for multi-resource diffs and per-resource grouping. - [ ] Add diff output serializers for rich/plain/json formats. - [ ] Include before/after content hashes and file modes in diff metadata for integrity checks. - [ ] Detect binary files and include a binary marker instead of inline diff content. - [ ] Add rename/move detection using path similarity + content hash and render as rename events. - [ ] Add max diff size guard with truncation notes and a `truncated=true` flag in JSON output. - [ ] Ensure diff output ordering is stable (resource name, path, change type). - [ ] Add `docs/reference/diff_review.md` with output format. - [ ] Tests (Behave): Add `features/diff_review.feature` for diff generation. - [ ] Tests (Robot): Add `robot/diff_review.robot` for review artifacts. - [ ] Tests (ASV): Add `benchmarks/diff_review_bench.py` for diff building performance. - [ ] Verify coverage >=97% via `nox -s coverage_report`. If coverage is <97% then review the current unit test coverage report at `build/coverage.xml` and use it to write new Behave based unit tests to improve code coverage. Specifically, write Behave style unit tests that are descriptively named and specifically improves coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `nox -s coverage_report` to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. - [ ] Run `nox` (all default sessions, including benchmark), fix any errors if needed ensuring nox passes across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. **Section**: ### Section 5: Actors, Skills & Tool Execution [WORKSTREAM C - Aditya Lead] **Status**: Open
freemo added this to the v3.1.0 milestone 2026-02-22 23:41:06 +00:00
Author
Owner

Expected completion (Day 15 rebaseline): Day 22 / 2026-03-02

**Expected completion (Day 15 rebaseline):** Day 22 / 2026-03-02
freemo added the due date 2026-02-28 2026-02-23 18:41:50 +00:00
freemo modified the milestone from v3.1.0 to v3.2.0 2026-02-24 21:54:37 +00:00
CoreRasurae added reference develop-luis-2 2026-02-25 07:40:29 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

2026-02-28

Reference
cleveragents/cleveragents-core#303
No description provided.