chore(init): trim deprecated --features help entries#781
chore(init): trim deprecated --features help entries#781MathurAditya724 merged 1 commit intomainfrom
Conversation
Remove metrics, sourcemaps, and crons from init help text and regenerate the skill reference so generated docs stay aligned with the command description. Made-with: Cursor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Bug Fixes 🐛
Internal Changes 🔧
🤖 This preview updates automatically when you update the PR. |
|
Codecov Results 📊✅ 138 passed | Total: 138 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 100.00%. Project has 1707 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 95.53% 95.53% —%
==========================================
Files 262 262 —
Lines 38172 38171 -1
Branches 0 0 —
==========================================
+ Hits 36466 36464 -2
- Misses 1706 1707 +1
- Partials 0 0 —Generated by Codecov Action |
| "Features to enable: errors,tracing,logs,replay,profiling,ai-monitoring,user-feedback", | ||
| variadic: true, | ||
| optional: true, |
There was a problem hiding this comment.
Bug: The init command's help text was updated to remove features, but the source documentation file docs/src/fragments/commands/init.md was not, creating a discrepancy.
Severity: LOW
Suggested Fix
Update the "Available Features" table in docs/src/fragments/commands/init.md to remove the rows for metrics, sourcemaps, and crons. This will align the source documentation with the changes made to the CLI command's help text.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: src/commands/init.ts#L219-L221
Potential issue: The pull request intended to remove `metrics`, `sourcemaps`, and
`crons` from the `--features` flag of the `init` command. While the CLI help text in
`src/commands/init.ts` was updated, the corresponding hand-written source documentation
in `docs/src/fragments/commands/init.md` was not. This file is the source of truth for
generating the documentation website. As a result, the CLI's `--help` output will list 7
available features, while the official documentation will still list all 10, leading to
user confusion and inconsistent information.
Did we get this right? 👍 / 👎 to inform future reviews.
Summary
metrics,sourcemaps, andcronsfrom thesentry init --featureshelp description in the command definition.initreference matches the updated CLI help text.Test plan
bun run generate:docssrc/commands/init.tsshows the updated feature listplugins/sentry-cli/skills/sentry-cli/references/init.mdreflects the same listMade with Cursor