Skip to content

example cleanup - #12

Merged
cirsteve merged 3 commits into
mainfrom
exampl_cleanup
Sep 8, 2026
Merged

cirsteve merged 3 commits into
mainfrom
exampl_cleanup

Conversation

@cirsteve

@cirsteve cirsteve commented Sep 8, 2026 •

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Chores

    • Removed the legacy pre-cutover capture and its associated conformance validation.
    • Limited push-based CI runs to the main branch while retaining pull request checks.
    • Removed the legacy archive from package artifact inclusion and verification.
  • Documentation

    • Clarified conformance claims, required fixtures, build requirements, event-store limitations, and synthetic quickstart examples.
  • Tests

    • Added coverage for event archive replay, duplicate handling, and empty imports.

@coderabbitai

coderabbitai Bot commented Sep 8, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Essentials

Run ID: d69529db-91f5-44aa-9468-7e0cdcd955f8

📥 Commits

Reviewing files that changed from the base of the PR and between 3cbd629 and 5117269.

📒 Files selected for processing (14)
  • .github/workflows/ci.yml
  • PAA.md
  • README.md
  • conformance/__init__.py
  • conformance/conftest.py
  • conformance/test_corpus_integrity.py
  • conformance/test_legacy_archive.py
  • examples/refund_quickstart/README.md
  • packages/paa-contracts/README.md
  • packages/paa-contracts/hatch_build.py
  • packages/paa-contracts/scripts/verify_built_wheel.py
  • packages/paa-contracts/src/paa_contracts/__init__.py
  • packages/paa-contracts/tests/test_contracts.py
  • tests/test_replay.py
💤 Files with no reviewable changes (4)
  • packages/paa-contracts/hatch_build.py
  • packages/paa-contracts/tests/test_contracts.py
  • packages/paa-contracts/scripts/verify_built_wheel.py
  • conformance/test_legacy_archive.py

Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


📝 Walkthrough

Walkthrough

The pull request removes the legacy pre-cutover capture from the repository and contract artifacts. It updates conformance and project documentation, restricts push-triggered CI to main, and adds tests for event replay behavior.

Changes

Legacy archive and conformance cleanup

Layer / File(s) Summary
Contract artifact removal
packages/paa-contracts/..., examples/legacy-archive/...
Removes the legacy archive from package inclusion, wheel verification, required roots, and contract tests.
Scope and documentation alignment
PAA.md, README.md, conformance/..., examples/refund_quickstart/README.md
Removes pre-cutover history claims and clarifies published-artifact and conformance requirements.
Replay boundary tests
tests/test_replay.py
Tests event-field preservation, atomic duplicate rejection, and empty-import no-op behavior.

CI trigger scope

Layer / File(s) Summary
Main-branch push trigger
.github/workflows/ci.yml
Limits push-triggered CI runs to main; pull-request triggers remain supported.

Priority: ⬇️ Low — Defer this cleanup because it removes legacy documentation and conformance artifacts while adding narrow replay-boundary tests, with no stated customer or production impact.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 51172

This change removes the legacy archive from contract and documentation scope, adds replay-boundary coverage, and limits push CI to main. No merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 55.56% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 9 functions across 5 files. (5 skipped: 5… Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The title is related to the removal and revision of example artifacts, but "example cleanup" is too broad and does not identify the main changes, including removal of the legacy archive and addition o… Use a specific title such as "Remove legacy archive artifacts and add replay boundary tests".
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title is related to the removal and revision of example artifacts, but "example cleanup" is too broad and does not identify the main changes, including removal of the legacy archive and addition of replay-boundary tests.

Full details: Docstring Coverage

Explanation

Docstring coverage is 55.56% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 9 functions across 5 files. (5 skipped: 5 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch exampl_cleanup

Comment @coderabbitai help to get the list of available commands.

cirsteve and others added 2 commits September 8, 2026 09:26
The capture deleted in the previous commit was still wired into four code
paths, so its removal broke the build rather than completing it. paa_contracts
lists every corpus directory in _REQUIRED_ROOTS and refuses to import over a
partial set, which took down the conformance suite, the contract package tests
and the wheel verification together. Drop the directory from _REQUIRED_ROOTS,
the build hook, the wheel verifier and the roots test, and delete the
conformance test that replayed it.

The docs claimed more for that artifact than it could carry. It was generated
from the same author's earlier implementation, and recorded
production_event_count_at_cutover: 0 -- a cross-implementation continuity proof
where both implementations are ours and the source system never ran a
transition. PAA.md and README.md no longer cite it, and the scope-of-claim
sentence drops the clause it was supporting.

import_events stays. It is exported from paa_runtime and the replayed capture
was its only test, so removing the fixture would have shipped a public API with
no coverage. tests/test_replay.py now covers it directly -- fields preserved
verbatim, one atomic transaction, empty input a no-op -- on events it builds
itself, since what is worth pinning is that the fields survive the call and not
that a particular file exists.

Also scope the push trigger to main. Unfiltered, it fired alongside
pull_request on every branch push, building each PR commit twice.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KF3srA4ZPg86FbETY3ZA2E
One move, repeated: state a fact, then add a clause about how disciplined it
was to state it. "Honest non-matches", "required, not decoration", "the
trade-off is named rather than hidden", "that is the part worth stating", "the
one failure mode it must not have", "the ratchet that keeps this honest",
"implementation-neutrality made mechanical instead of asserted". Each one asks
the reader to admire the rigor instead of just showing it.

Every fact survives; only the self-assessment is gone. "Scope of the claim"
loses the pull-quote staging and says the same thing in prose. The conftest
docstring drops a paragraph narrating its own development history, which no
reader of the fixture needs.

Left alone: the "deliberately"/"on purpose" uses that carry real information --
a deliberately tampered fixture, stages deliberately not checked, structural
rules deliberately absent. Those distinguish intent from accident, which is
worth saying in a spec. Docstrings under src/paa_runtime were already dry and
are untouched.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KF3srA4ZPg86FbETY3ZA2E
@cirsteve
cirsteve merged commit edfaee1 into main Sep 8, 2026
5 checks passed
@cirsteve
cirsteve deleted the exampl_cleanup branch September 8, 2026 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant