Skip to content

feat(cli): grade in map --json and a --baseline-label flag - #773

Merged
HugoRCD merged 2 commits into
mainfrom
feat/cli-grade-and-baseline-label
Oct 4, 2026
Merged

HugoRCD merged 2 commits into
mainfrom
feat/cli-grade-and-baseline-label

Conversation

@HugoRCD

@HugoRCD HugoRCD commented Oct 4, 2026 •

Copy link
Copy Markdown
Member

Two follow-ups surfaced by evloghq/action, which had to carry both itself.

  • evlog map --json carries grade (excellent / good / needs-work / poor) next to map and summary. The action recomputed it from the score thresholds, which drifts the day a threshold moves.
  • --baseline-label <text> names the baseline in the report and in the --format github annotations. The action scans the base branch into a temp file and passes it as --baseline, so the gate line read regressed against /tmp/evlog-base-x/….json; now it can say regressed against main.
$ evlog map --format github --baseline /tmp/base.json --baseline-label main --no-write
::error file=server/routes/health.get.ts,line=1,title=evlog map%3A wide-event::…
::error title=evlog map::score 56/100 (needs-work): 4 instrumented, 0 partial, 8 dark; regressed against main

Tests: grade asserted on the JSON payload; the regressions-only annotation test passes the label and asserts the gate line. Docs: flag row on cli/map. Changeset: @evlog/cli minor.

Summary by CodeRabbit

  • New Features
    • JSON map output now includes the scan grade.
    • Added --baseline-label to name the baseline in reports and GitHub-format annotations.
  • Documentation
    • Updated the --format github documentation link.

@vercel

vercel Bot commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
evlog-docs Ready Ready Preview, v0 Oct 4, 2026 11:20am UTC
evlog-render-lab Ready Ready Preview Oct 4, 2026 11:20am UTC
3 Skipped Deployments
Project Deployment Actions Updated
evi Skipped Skipped Oct 4, 2026 11:20am UTC
evlog-telemetry Skipped Skipped Oct 4, 2026 11:20am UTC
just-use-evlog Skipped Skipped Oct 4, 2026 11:20am UTC

Request Review

@github-actions

github-actions Bot commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Thank you for following the naming conventions! 🙏

@coderabbitai

coderabbitai Bot commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used
📚 Code guidelines (4)
apps/docs/AGENTS.md — auto-discovered
.agents/skills/create-map-rule/SKILL.md — Agent Skill
.agents/skills/create-enricher/SKILL.md — Agent Skill
AGENTS.md — auto-discovered

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1fc5d0f7-0300-42c0-965f-5cc8e0f2fbae
📥 Commits

Reviewing files that changed from the base of the PR and between c7c7e6c and 2a1f57a.

📒 Files selected for processing (4)
  • .changeset/cli-grade-baseline-label.md
  • apps/docs/content/3.cli/2.map.md
  • packages/cli/src/commands/map.ts
  • packages/cli/test/map.command.test.ts

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 1 remain after this review.


📝 Walkthrough

Walkthrough

The map command accepts a custom label for a loaded baseline and includes the scan grade in JSON output. The CLI documentation link for GitHub format output now points to the CI page’s “without the action” section.

Changes

Map CLI

Layer / File(s) Summary
Baseline label input and reporting
packages/cli/src/commands/map.ts, packages/cli/test/map.command.test.ts
The command accepts --baseline-label and uses a nonempty value as the loaded baseline’s source label. The regression test checks that the error notice names the supplied label.
JSON grade output
packages/cli/src/commands/map.ts, packages/cli/test/map.command.test.ts, .changeset/cli-grade-baseline-label.md, apps/docs/content/3.cli/2.map.md
JSON output includes the scan grade, and the test checks it against four accepted values. The changeset records the grade and baseline-label updates. The CLI documentation link for GitHub format output now points to the CI page’s “without the action” section.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to 2a1f5

The change adds the requested baseline label and JSON grade behavior; no concrete merge-blocking risk is identified.

Security Architecture Review

Security architecture risk: 🔵 Low · up to 2a1f5

The changes are limited to report data and baseline display names. The label does not select the baseline or control regression decisions, and GitHub annotations escape caller-controlled text. No material security concern was identified in the reviewed paths.

Retained concerns
No architecture-level concerns identified.

Security review details

Security Blast Radius

  • inferred — The reviewed additions affect CLI report consumers and GitHub annotation readers. The label adds control over presentation, without adding control over baseline source selection, comparison identity, or gate authority.

Trust Boundaries and Controls

  • observed — Caller-controlled baseline text reaches the GitHub regression message through the annotation helper. That helper escapes percent, carriage-return, and newline characters before emission; the label is not interpolated into annotation properties.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the two main CLI changes: adding grade to JSON output and adding --baseline-label.
Description check ✅ Passed The description explains both changes, why they are needed, and includes an example, test details, documentation updates, and the changeset. It does not include the template’s linked-issue section or …
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (2 skipped: 2 …
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.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@pkg-pr-new

pkg-pr-new Bot commented Oct 4, 2026 •

Copy link
Copy Markdown
@evlog/cli

npm i https://pkg.pr.new/@evlog/cli@773

evlog

npm i https://pkg.pr.new/evlog@773

@evlog/nuxthub

npm i https://pkg.pr.new/@evlog/nuxthub@773

@evlog/signals

npm i https://pkg.pr.new/@evlog/signals@773

@evlog/telemetry

npm i https://pkg.pr.new/@evlog/telemetry@773

commit: 2a1f57a

@vercel
vercel Bot temporarily deployed to Preview – just-use-evlog October 4, 2026 11:17 Inactive
@vercel
vercel Bot temporarily deployed to Preview – evlog-telemetry October 4, 2026 11:17 Inactive
@vercel
vercel Bot temporarily deployed to Preview – evi October 4, 2026 11:17 Inactive
@HugoRCD
HugoRCD merged commit a053adb into main Oct 4, 2026
20 checks passed
@HugoRCD
HugoRCD deleted the feat/cli-grade-and-baseline-label branch October 4, 2026 11:54

This branch was successfully deployed

2 active and 3 inactive deployments
Preview – evlog-docs — 2a1f57a3 Deployed Oct 4, 2026 by vercel[bot]
Preview – evlog-render-lab — 2a1f57a3 Deployed Oct 4, 2026 by vercel[bot]
Preview – just-use-evlog — 2a1f57a3 Deployed Oct 4, 2026 by vercel[bot]
Preview – evlog-telemetry — 2a1f57a3 Deployed Oct 4, 2026 by vercel[bot]
Preview – evi — 2a1f57a3 Deployed Oct 4, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant