Skip to content

chore(init): trim deprecated --features help entries#781

Merged
MathurAditya724 merged 1 commit intomainfrom
chore/init-features-help-sync
Apr 20, 2026
Merged

chore(init): trim deprecated --features help entries#781
MathurAditya724 merged 1 commit intomainfrom
chore/init-features-help-sync

Conversation

@MathurAditya724
Copy link
Copy Markdown
Member

Summary

  • Remove metrics, sourcemaps, and crons from the sentry init --features help description in the command definition.
  • Regenerate command skill/reference docs so the generated init reference matches the updated CLI help text.

Test plan

  • Run bun run generate:docs
  • Verify src/commands/init.ts shows the updated feature list
  • Verify plugins/sentry-cli/skills/sentry-cli/references/init.md reflects the same list

Made with Cursor

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
@github-actions
Copy link
Copy Markdown
Contributor

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


New Features ✨

  • (issue) Add resolve, unresolve (reopen), and merge commands by BYK in #778

Bug Fixes 🐛

  • (error-reporting) Fall back to message prefix for ValidationError without field by BYK in #776
  • (hex-id) Auto-recover malformed hex IDs in view commands (CLI-16G) by BYK in #777

Internal Changes 🔧

  • (init) Trim deprecated --features help entries by MathurAditya724 in #781
  • Regenerate docs by github-actions[bot] in 58a84035

🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Copy Markdown
Contributor

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://cli.sentry.dev/_preview/pr-781/

Built to branch gh-pages at 2026-04-20 11:12 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@MathurAditya724 MathurAditya724 enabled auto-merge (squash) April 20, 2026 11:12
@github-actions
Copy link
Copy Markdown
Contributor

Codecov Results 📊

138 passed | Total: 138 | Pass Rate: 100% | Execution Time: 0ms

📊 Comparison with Base Branch

Metric Change
Total Tests
Passed Tests
Failed Tests
Skipped Tests

✨ No test changes detected

All tests are passing successfully.

✅ Patch coverage is 100.00%. Project has 1707 uncovered lines.
✅ Project coverage is 95.53%. Comparing base (base) to head (head).

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

Comment thread src/commands/init.ts
Comment on lines +219 to 221
"Features to enable: errors,tracing,logs,replay,profiling,ai-monitoring,user-feedback",
variadic: true,
optional: true,
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@MathurAditya724 MathurAditya724 merged commit 4fd848b into main Apr 20, 2026
20 checks passed
@MathurAditya724 MathurAditya724 deleted the chore/init-features-help-sync branch April 20, 2026 11:17
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.

2 participants