Skip to content

refactor: adopt shared README table formatting - #293

Merged
acgetchell merged 1 commit into
mainfrom
refactor/285-table-formatting
Oct 20, 2026
Merged

acgetchell merged 1 commit into
mainfrom
refactor/285-table-formatting

Conversation

@acgetchell

@acgetchell acgetchell commented Oct 20, 2026 •

Copy link
Copy Markdown
Owner

The README benchmark publisher rewrites shared Markdown cells and prose to obtain its six-column table. Adopt the published research-repo-tools==0.2.0 RunTableStyle API directly, preserving mean/median selection, recorded interval bounds, the confidence caption, explicit speedup direction, original peer phases, and the README figure and transactional asset pointers.

Remove the obsolete CSV conversion declaration and pre-Just Python phase replay. Historical reports, CSV/JSON, provenance, archives, and measured assets remain unchanged. Remove shared implementation test matrices already covered by the published upstream suite, consolidate exact package pin/registry/distribution checks, and retain la-stack's scientific, native-recipe, release, and publication integration coverage.

Validation on macOS: just python-check, just markdown-fix, just check, and just ci passed. Final CI includes 160 Python tests, 1,031 Rust tests, default/exact doctests, and the remaining configuration, documentation, build, and example checks. Focused coverage runs the actual just performance-readme recipe against the installed package for mean and median; offline rendering of the retained published run preserves SVG and CSV bytes. Refreshing the current README correctly rejects its existing stale source digest without changing publication files. New benchmark measurements are unnecessary for this presentation and tooling cleanup.

Native Linux/macOS/Windows CI on the PR supplies the remaining adoption-commit validation required by #285.

Closes #285

Summary by CodeRabbit

  • Updates

    • Updated the project’s benchmark and release tooling to research-repo-tools 0.2.0.
    • Benchmark tables now use consistent formatting, confidence-level labels, and clearer speedup descriptions.
    • Performance reports and README publication require complete-run evidence from the declared workflow.
  • Documentation

    • Updated setup, release, benchmarking, and performance guidance for the new tooling and reporting process.
    • Clarified how to read archived performance records and their limitations.
  • Validation

    • Expanded checks for published tooling packages, report formatting, measurements, and release requirements.

- Use published research-repo-tools v0.2.0 table styles for dimensions,
  confidence bounds, and explicitly directed speedup ratios.
- Retire legacy CSV conversion and pre-Just phase replay while preserving
  historical reports, assets, and evidence.
- Retain la-stack integration coverage and consolidate package identity
  checks, leaving shared implementation matrices upstream.

Refs #285
@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: acgetchell/la-stack/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: d740aa1b-b5da-44cb-b541-2a8159d7769b
📥 Commits

Reviewing files that changed from the base of the PR and between d8bbb58 and 92ed845.

⛔ Files ignored due to path filters: 1
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing: 17
  • .github/workflows/release-benchmarks.yml
  • CONTRIBUTING.md
  • docs/BENCHMARKING.md
  • docs/RELEASING.md
  • docs/code_organization.md
  • docs/dev/performance-tooling-adoption.md
  • docs/performance/README.md
  • pyproject.toml
  • scripts/README.md
  • scripts/archive_performance.py
  • scripts/performance_runs.py
  • scripts/tests/test_changelog_integration.py
  • scripts/tests/test_performance_workflow.py
  • scripts/tests/test_release_baseline.py
  • scripts/tests/test_release_publishing.py
  • scripts/tests/test_toolchain_integration.py
  • tooling/performance-legacy.toml
💤 Files with no reviewable changes: 1
  • tooling/performance-legacy.toml

Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

📝 Walkthrough

The project now pins research-repo-tools 0.2.0 and uses its shared renderer for README benchmark tables. Scientific-run validation requires the declared compatibility and phase evidence. Legacy CSV conversion and Python phase replay paths are removed, and documentation and tests reflect these changes.

Changes: Performance tooling adoption

Layer / File(s) Summary
Pin the published tooling package
.github/workflows/release-benchmarks.yml, pyproject.toml, scripts/tests/test_toolchain_integration.py, scripts/tests/test_release_baseline.py, scripts/tests/test_release_publishing.py, scripts/tests/test_changelog_integration.py, CONTRIBUTING.md, docs/RELEASING.md, docs/code_organization.md, scripts/README.md, docs/dev/performance-tooling-adoption.md
The dependency and release commands now use research-repo-tools 0.2.0. Integration tests check the published package contract and derive the requirement from the manifest. Release and changelog tests were updated.
Use shared README table rendering
scripts/archive_performance.py, scripts/tests/test_performance_workflow.py, docs/BENCHMARKING.md, docs/code_organization.md, docs/dev/performance-tooling-adoption.md, scripts/README.md
README publication configures RunTableStyle and calls render_run_table instead of rewriting rendered Markdown. Tests cover mean and median output, table presentation, and archive preservation.
Require current evidence and retire legacy conversion
scripts/performance_runs.py, tooling/performance-legacy.toml, scripts/tests/test_performance_workflow.py, docs/BENCHMARKING.md, docs/code_organization.md, docs/dev/performance-tooling-adoption.md, docs/performance/README.md, scripts/README.md
Validation now compares compatibility, phase context, and recorded commands with the declared measurement plan. The legacy CSV configuration and conversion path were removed. Tests and documentation describe retained reports and current evidence requirements.

Priority: ➖ Normal

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

Change: Refactor

Possibly related issues

Merge Risk: ⚪ Minimal · up to 92ed8

The change adopts the published research-repo-tools 0.2.0 renderer for README benchmark tables and retires legacy conversion paths. No concrete merge-blocking risk was identified in the supplied context.

Pre-merge checks: Passed 3 · Inconclusive 1

Failed Failed checks: 1 inconclusive

Check name Status Explanation Resolution
Linked Issues check Inconclusive Issue #285 requirements are supported for the renderer migration: README_TABLE_STYLE uses the published RunTableStyle API, _readme_table and Markdown rewriting are removed, mean/median coverage … Provide reviewable evidence for uv.lock showing the exact published research-repo-tools==0.2.0 resolution, source, and required hashes.
Passed Passed checks: 3 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title accurately identifies the primary change: replacing local README table formatting with the shared RunTableStyle renderer. It is concise and specific.
Out of Scope Changes check Passed The changed workflows, documentation, dependency declarations, publisher, validation logic, and tests support issue #285. Removing the obsolete CSV conversion declaration, pre-Just replay, and upstrea…
Full details: Out of Scope Changes check

Explanation

The changed workflows, documentation, dependency declarations, publisher, validation logic, and tests support issue #285. Removing the obsolete CSV conversion declaration, pre-Just replay, and upstream-covered test matrices matches the stated tooling-adoption scope. No unrelated change is demonstrated.

Full details: Linked Issues check

Explanation

Issue #285 requirements are supported for the renderer migration: README_TABLE_STYLE uses the published RunTableStyle API, _readme_table and Markdown rewriting are removed, mean/median coverage and retained publication checks remain, and the summary reports the required Python, documentation, configuration, and native CI validation. The exact research-repo-tools==0.2.0 manifest pin is reviewable, but uv.lock is excluded from review. The lockfile version, source, and hashes cannot be independently verified from the available evidence.

Resolution

Provide reviewable evidence for uv.lock showing the exact published research-repo-tools==0.2.0 resolution, source, and required hashes.

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@codecov

codecov Bot commented Oct 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.25%. Comparing base (d8bbb58) to head (92ed845).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #293   +/-   ##
=======================================
  Coverage   98.25%   98.25%           
=======================================
  Files          14       14           
  Lines        7218     7218           
=======================================
  Hits         7092     7092           
  Misses        126      126           
Flag Coverage Δ
unittests 98.25% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@acgetchell
acgetchell enabled auto-merge October 20, 2026 00:32
@acgetchell
acgetchell merged commit 694f708 into main Oct 20, 2026
19 checks passed
@acgetchell
acgetchell deleted the refactor/285-table-formatting branch October 20, 2026 01:08
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.

Replace _readme_table with published shared table formatting options

1 participant