Skip to content
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

[CLI Improvements] Deprecate commands #2301

Open
Tracked by #2182
schoren opened this issue Apr 3, 2023 · 6 comments
Open
Tracked by #2182

[CLI Improvements] Deprecate commands #2301

schoren opened this issue Apr 3, 2023 · 6 comments
Labels

Comments

@schoren
Copy link
Collaborator

schoren commented Apr 3, 2023

As we move resources to the resourcemanager architecture, some commands are no longer needed, since they are replaced by the [verb] [resource] new approach.

We still want to maintain backwards compatibility for existing scripts and such, so we need to still support the old commands, but make sure we let users know they are deprecated, and will be removed in future versions.

When a user tries to run one of the "old" commands, we need to show the following warning:

⚠️  Warning: The "tracetest [OLD COMMAND]" command will be deprecated soon. 
Please use the new CRUD-style format: "tracetest run [verb] [resource]".

For example, when running tracetest test run ..., we should display:

⚠️  Warning: The "tracetest test run" command will be deprecated soon. 
Please use the new CRUD-style format: "tracetest run [verb] [resource]".

List of commands (including its subcommands) to deprecate:

  • export
  • datastore
  • environment
  • test
@olha23
Copy link

olha23 commented Apr 5, 2023

do we need to include the deprecation message now in CLI for user who use test run command?
something like this:
⚠️ Warning: The "tracetest run test" command will be deprecated soon. Please use the new CRUD-style format: "tracetest run [verb] [resource]".

@schoren
Copy link
Collaborator Author

schoren commented Apr 5, 2023

@olha23 addede the message to the description

@xoscar xoscar changed the title deprecate commands [CLI Improvements] Deprecate commands Apr 10, 2023
@xoscar xoscar added the CLI label Apr 10, 2023
@xoscar
Copy link
Collaborator

xoscar commented Apr 10, 2023

Let's add something at the top that marks this blocked until this #2297 is done

@mathnogueira
Copy link
Member

Just a correction, tracetest test run should be deprecated. Not tracetest run test

@schoren
Copy link
Collaborator Author

schoren commented Apr 13, 2023

@mathnogueira good catch. Just updated the description to relfect this

@jorgeepc
Copy link
Contributor

jorgeepc commented May 9, 2023

Deprecation of datastore and environment was included here: #2498

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants