Skip to content

feat: Mark all files subcommands as deprecated. #2512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025

Conversation

Swatinem
Copy link
Member

@Swatinem Swatinem commented May 20, 2025

The commands are now hidden from help output (making them less likely to be discovered and used), and they are marked with a deprecation notice.

When invoking the commands, a deprecation notice will be printed as well.

Also the previously deprecated sourcemaps explain command (which was replaced by an in-app sourcemaps debugger) which already prints a deprecation notice is also being marked as hidden to be less discoverable.

Ref #2513

@Swatinem Swatinem requested a review from szokeasaurusrex May 20, 2025 09:21
@Swatinem Swatinem self-assigned this May 20, 2025
@Swatinem Swatinem force-pushed the swatinem/deprecate-release-files branch from 425455b to dbdb6a3 Compare May 20, 2025 09:23
@szokeasaurusrex szokeasaurusrex changed the title Marke all files subcommands as deprecated. feat: Mark all files subcommands as deprecated. May 20, 2025
Copy link
Member

@szokeasaurusrex szokeasaurusrex left a comment

Choose a reason for hiding this comment

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

two small comments, otherwise looks good! I'm gonna open an issue to fully remove these commands with the next major release

Comment on lines 47 to 48
println!("{}", style("⚠ DEPRECATION NOTICE: This functionality will be removed in a future version of `sentry-cli`. \
Use the `sourcemaps` command instead.").yellow());
Copy link
Member

Choose a reason for hiding this comment

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

We should probably use eprintln! for this:

Suggested change
println!("{}", style("⚠ DEPRECATION NOTICE: This functionality will be removed in a future version of `sentry-cli`. \
Use the `sourcemaps` command instead.").yellow());
eprintln!("{}", style("⚠ DEPRECATION NOTICE: This functionality will be removed in a future version of `sentry-cli`. \
Use the `sourcemaps` command instead.").yellow());

We will also need to update this docs section (including subsections) to reflect this change; that page makes it seem like the sourcemaps commands are a "special case" of the files commands

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.
Thanks for the reminder: getsentry/sentry-docs#13767

The commands are now hidden from help output (making them less likely to be discovered and used), and they are marked with a deprecation notice.

When invoking the commands, a deprecation notice will be printed as well.

Also the previously deprecated `sourcemaps explain` command (which was explained by an in-app sourcemaps debugger)  which already prints a deprecation notice is also being marked as hidden to be less discoverabe.
@Swatinem Swatinem force-pushed the swatinem/deprecate-release-files branch from dbdb6a3 to 1c4594c Compare May 20, 2025 11:48
@Swatinem Swatinem requested a review from szokeasaurusrex May 20, 2025 11:55
@Swatinem Swatinem merged commit 5a7159e into master May 20, 2025
18 checks passed
@Swatinem Swatinem deleted the swatinem/deprecate-release-files branch May 20, 2025 12:15
chromy added a commit that referenced this pull request May 27, 2025
- Hide the command from the help menu.
- Print a deprecation notice when the command is used.

Modelled on #2512

Fixes #2488
chromy added a commit that referenced this pull request May 27, 2025
- Hide the command from the help menu.
- Print a deprecation notice when the command is used.

Modelled on #2512

Fixes #2488
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