feat(release): surface adoption and health metrics in list and view (#463)#680
Merged
feat(release): surface adoption and health metrics in list and view (#463)#680
Conversation
Contributor
Semver Impact of This PR🟡 Minor (new features) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Bug Fixes 🐛Dashboard
Other
Internal Changes 🔧
🤖 This preview updates automatically when you update the PR. |
Contributor
|
Contributor
Codecov Results 📊✅ 134 passed | Total: 134 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 85.77%. Project has 1523 uncovered lines. Files with missing lines (3)
Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
- Coverage 95.47% 95.35% -0.12%
==========================================
Files 224 225 +1
Lines 32591 32782 +191
Branches 0 0 —
==========================================
+ Hits 31115 31259 +144
- Misses 1476 1523 +47
- Partials 0 0 —Generated by Codecov Action |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
…463) Add health/adoption data to the existing release commands: - Pass `health=1` to the list endpoint so each release includes per-project adoption and crash-free metrics - Add ADOPTION and CRASH-FREE columns to `release list` table - Add `health`, `adoptionStages`, and `healthStatsPeriod` query options to `getRelease()` API function - Show per-project health breakdown table in `release view` (crash-free users/sessions, adoption %, 24h user/session counts) - Color-code crash-free rates (green ≥ 99%, yellow ≥ 95%, red < 95%) - Gracefully omit health section when no project has session data
Address Cursor Bugbot review — deduplicate the percentage and count formatting helpers into a shared module imported by both list and view.
Support sorting releases by: date (default), sessions, users, crash_free_sessions, crash_free_users. Switches from buildOrgListCommand to buildListCommand to support the custom flag (-s alias).
…ses and session sparklines - Extract compactFormatter, formatNumber, fmtPct, fmtCount, appendUnitSuffix, formatWithUnit, formatCompactWithUnit into src/lib/formatters/numbers.ts - Update dashboard.ts to import from shared module (no behavior change) - Delete src/commands/release/format.ts — replaced by shared module - Add sort aliases: stable_sessions/cfs → crash_free_sessions, stable_users/cfu → crash_free_users - Add SESSIONS sparkline column to release list table using health stats time-series data (same [timestamp, count] format as issue stats) - Drop COMMITS column from list to make room for sparkline
…e URLs Major enhancements to `release list` to match the Sentry releases page: API layer: - Add project (numeric ID[]), environment (string[]), statsPeriod, and status query params to listReleasesPaginated - Add listReleasesForProject helper that resolves slug → numeric ID - Add buildReleaseUrl to sentry-urls.ts (URI-encoded versions) New flags: - --environment/-e: filter by environment (e.g., production) - --period/-t: health stats period (default 90d, matching web UI) - --status: open (default) or archived Project scoping: - Wire listForProject in OrgListConfig so DSN auto-detection and explicit org/project targets scope releases to the detected project Rich styling (matching issue list patterns): - Bold version names linked to Sentry release page - 2-line VERSION cell: version + muted "age | deploy-env" subtitle - Colored adoption: green ≥50%, yellow ≥10% - Colored crash-free rate: green ≥99%, yellow ≥95%, red <95% - Colored crashes: red when >0, green when 0 - Muted session sparklines - Muted row separators between rows - Right-aligned numeric columns (ADOPTION, CRASH-FREE, CRASHES, NEW ISSUES)
Export fmtCrashFree from view.ts and import in list.ts instead of maintaining two identical implementations (addresses Bugbot review).
The default auto-detect handler only resolves org slugs and fetches ALL releases in the org, burying project-specific releases in noise. Override auto-detect to use resolveAllTargets which gets org+project+projectId from DSN detection, then pass numeric project IDs to the API for scoped results. This matches how issue list handles project-scoped auto-detect.
Environment filtering:
- Support multiple -e flags: -e production -e development
- Support comma-separated: -e production,development
- Variadic flag via Stricli variadic: true
Smart production default:
- When no --environment is passed and a single project is auto-detected,
call listProjectEnvironments to check if "production" or "prod" exists
- Auto-select it as the default, matching the Sentry web UI behavior
- Show "Environment: production (use -e to change)" hint so it is clear
- One lightweight API call (project environments list), cached by region
API layer:
- Add listProjectEnvironments using @sentry/api listAProject_sEnvironments
- Returns Array<{ id, name, isHidden }> for visible environments
…ection When multiple DSNs are detected (e.g., cli from src/lib/constants.ts and cli-website from docs/sentry.client.config.js), rank targets by source path: src/lib/app/ and .env files get priority 0, root-level configs get priority 1, docs/test/scripts get priority 2. Picks only the top- ranked target for auto-detect, preventing mixed releases from unrelated projects.
…ect guarantee Rewrite auto-detect handler to properly handle multiple detected projects, following the issue list pattern: - Fetch from ALL detected projects in parallel (not just the primary) - Tag each release with targetProject for the PROJECT column - Client-side sort by dateCreated descending after merging - Guarantee at least 1 release per project in trimmed output - Dynamic columns: add PROJECT column only in multi-project mode - Smart env default still applied from primary (highest-ranked) target - Properly show resolveAllTargets footer with all detected projects Ranking heuristic (for env default): src/lib/app/ paths rank highest, root-level configs rank middle, docs/test/scripts rank lowest.
…ted dashes
Address Bugbot review:
- Replace hardcoded sortByDateDesc with configurable buildMergeSorter
that maps each --sort value to the correct release field
- Make fmtCrashFree return colorTag("muted", "—") for null values,
consistent with other columns (ADOPTION, CRASHES)
…argets The production environment auto-default only ran in the auto-detect override, not for explicit targets like sentry/cli. Move the env resolution into func() via resolveEnvForParsedTarget so it applies to explicit mode too. Shows "Environment: production (use -e to change)" hint when auto-defaulting.
…shes - Fix inline comment in func() that incorrectly claimed env default applies to project-search mode (it only handles explicit mode) - Wrap fmtPct/fmtCount results with mutedIfDash in view.ts health table so null values show as muted "—" consistently with fmtCrashFree
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 75f18af. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
release listandrelease viewcommandshealth=1to the releases API so adoption and crash-free metrics are populatedreleasecommand group with adoption/health subcommand #463Changes
API layer (
src/lib/api/releases.ts):listReleasesPaginatedgainshealth?: booleanoptiongetReleasegains optional{ health, adoptionStages, healthStatsPeriod }query paramsReleaseSortValuetype for future--sortsupportList command (
src/commands/release/list.ts):health=1in bothlistForOrgandlistPaginatedhasHealthData: trueView command (
src/commands/release/view.ts):health=true, adoptionStages=trueon every viewTests (
test/commands/release/view.test.ts):projects[].healthDatafields pass throughhasHealthData: false