Skip to content

chore: improve comparison comments#923

Open
avivkeller wants to merge 2 commits into
mainfrom
improve-comparison-comments
Open

chore: improve comparison comments#923
avivkeller wants to merge 2 commits into
mainfrom
improve-comparison-comments

Conversation

@avivkeller

Copy link
Copy Markdown
Member

Makes these comments less detailed, and fixes formatting issues

@avivkeller
avivkeller requested a review from a team as a code owner July 19, 2026 19:31
@cursor

cursor Bot commented Jul 19, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Changes are limited to comparator scripts and their tests that format CI comments; no runtime product or auth/data paths are affected.

Overview
Refactors how CI generator comparison comments are built so they’re shorter, easier to scan, and handle nested output correctly.

Shared listOutputFiles now walks artifact trees with glob, skips metadata (benchmark.json, comparison.txt), and is used by both comparators. File-size and object diffs include added/removed paths (not only files present on both sides); size output leads with a one-line summary (file count + net bytes) and tucks the table under a <details> block with Main / PR columns and when a side is missing.

Performance output drops user/system CPU and the old four-column table in favor of two bullets—generation time and peak memory—with directional wording (e.g. slower/faster) and a single CI run caveat.

Reviewed by Cursor Bugbot for commit 7c338d2. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel

vercel Bot commented Jul 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Jul 20, 2026 5:19am

Request Review

@codecov

codecov Bot commented Jul 19, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 98.43750% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.99%. Comparing base (ada6540) to head (7c338d2).

Files with missing lines Patch % Lines
scripts/comparators/object-assertion.mjs 95.23% 1 Missing ⚠️
scripts/comparators/performance.mjs 94.11% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #923      +/-   ##
==========================================
+ Coverage   84.92%   84.99%   +0.06%     
==========================================
  Files         192      193       +1     
  Lines       17506    17576      +70     
  Branches     1551     1569      +18     
==========================================
+ Hits        14867    14938      +71     
+ Misses       2633     2632       -1     
  Partials        6        6              

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

api-links Generator

Performance estimate (single CI run)

  • Generation time: 4.3% slower (1.39 s → 1.45 s)
  • Peak memory: 1.1% higher (350.08 MB → 353.92 MB)

legacy-html Generator

Performance estimate (single CI run)

  • Generation time: 27.0% faster (19.14 s → 13.98 s)
  • Peak memory: 0.1% lower (2.20 GB → 2.20 GB)

legacy-json Generator

Performance estimate (single CI run)

  • Generation time: 10.9% slower (8.89 s → 9.86 s)
  • Peak memory: 2.5% higher (1.66 GB → 1.70 GB)

llms-txt Generator

Performance estimate (single CI run)

  • Generation time: 2.3% faster (8.68 s → 8.48 s)
  • Peak memory: 3.4% higher (1.64 GB → 1.69 GB)

orama-db Generator

Output size: 1 file changed · net +1.34 KB

File size details
File Main PR Change
orama-db.json 8.90 MB 8.90 MB +1.34 KB (+0.0%)

Performance estimate (single CI run)

  • Generation time: 59.7% slower (5.96 s → 9.52 s)
  • Peak memory: 0.5% lower (1.79 GB → 1.78 GB)

web Generator

Output size: 3 files changed · net +202.00 B

File size details
File Main PR Change
FunctionSignature-Vk-eQGF1.js 189.94 KB -189.94 KB (-100.0%)
FunctionSignature-Cxd8hOuQ.js 189.94 KB +189.94 KB
all.html 21.28 MB 21.28 MB +202.00 B (+0.0%)

Performance estimate (single CI run)

  • Generation time: 23.1% faster (78.79 s → 60.56 s)
  • Peak memory: 6.2% higher (5.78 GB → 6.14 GB)

@avivkeller
avivkeller marked this pull request as draft July 19, 2026 20:29
@avivkeller
avivkeller marked this pull request as ready for review July 20, 2026 06:19
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