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.

Sign up for GitHub

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

Jump to bottom

chore: Sunset soon to be legacy commands #308

Merged
merged 6 commits into from
Apr 11, 2022
Merged

chore: Sunset soon to be legacy commands #308

merged 6 commits into from
Apr 11, 2022

Conversation

raulb
Copy link
Member

@raulb raulb commented Apr 11, 2022 •
edited
Loading

Description of change

Type of change

  • New feature
  • Bug fix
  • Refactor
  • Documentation

How was this tested?

  • Unit Tests
  • Tested in staging
  • Tested in minikube

Demo

Before

  • All commands functioning as expected

Now

  • All commands functioning as expected, but:
  1. No public documentation
  2. Shows the following messages before execution (command will still work as before):

Pipelines

❯ .m pipelines
Command "pipelines" is deprecated, we encourage you operate with applications via `apps` instead

❯ .m pipelines create
Command "pipelines create" is deprecated, we encourage you to create applications via `apps deploy` instead.

❯ .m pipelines describe
Command "pipelines describe" is deprecated, we encourage you to describe your application via `apps describe` instead.

❯ .m pipelines ls
Command "pipelines list" is deprecated, we encourage you to list your applications via `apps ls` instead.

❯ .m pipelines remove
Command "pipelines remove" is deprecated, we encourage you to remove your application via `apps remove` instead.

❯ .m pipelines update
Command "pipelines update" is deprecated, we encourage you to operate with applications via `apps` instead.

Connect / Connectors

❯ .m connect
Command "connect" is deprecated, we encourage you to operate with your applications via `apps` instead.

❯ .m connectors
Command "connectors" is deprecated, we encourage you to operate with your application via `apps` instead.

❯ .m connectors create
Command "connectors create" is deprecated, we encourage you to create applications via `apps deploy` instead.

❯ .m connectors describe
Command "describe" is deprecated, we encourage you to describe your application via `apps describe` instead.

❯ .m connectors list
Command "connectors list" is deprecated, we encourage you to list your applications via `apps ls` instead.

❯ .m connectors logs
Command "connectors logs" is deprecated, we encourage you to operate with your applications via `apps` instead.

❯ .m connectors remove
Command "connectors remove" is deprecated, we encourage you to remove your application via `apps remove` instead.

❯ .m connectors update
Command "connectors update" is deprecated, we encourage you to operate with applications via `apps` instead.

Additional references

⚠️ do not release until we have a changelog explaining this change ⚠️

Documentation updated

It'll be done with #309 so we generate only one updated documentation for all.

@raulb raulb added the blocked Not ready to ship label Apr 11, 2022
@raulb raulb self-assigned this Apr 11, 2022
jayjayjpg
jayjayjpg approved these changes Apr 11, 2022
View reviewed changes
Copy link
Contributor

@jayjayjpg jayjayjpg left a comment

Choose a reason for hiding this comment

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

This reads great and thank you for the swift iteration! ✨

@raulb raulb mentioned this pull request Apr 11, 2022
Merged
4 tasks
@raulb
Copy link
Member Author

raulb commented Apr 11, 2022

This breaks the expected output when using --json. Looking...

@raulb
fix: output
8d5a213
@raulb
feat: Implement our own deprecated builder
a09d018 
What this does is a bit more complete than Cobra’s implementation for the following reasons:

1. Includes the whole command (at least parent + subcommand) that would make more sense to customers (i.e.: we control the entire deprecated message if we need to):

*Before*

```bash
$ meroxa pipelines list
Command “list” is deprecated….
```

*Now*

```
$ meroxa apps list
Command “apps list” is deprecated…
```

2. We still hide the command (for documentation purposes), and we can control to not show it with json options
@raulb raulb force-pushed the raul/sunset-connectors-and-pipelines branch from f81886a to a09d018 Compare April 11, 2022 16:59
@raulb
Copy link
Member Author

raulb commented Apr 11, 2022

Implemented our own way to deprecate commands so we have better control on both messaging and its output: a09d018

@raulb raulb merged commit 53f10c4 into master Apr 11, 2022
@raulb raulb deleted the raul/sunset-connectors-and-pipelines branch April 11, 2022 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jayjayjpg jayjayjpg jayjayjpg approved these changes

Assignees

@raulb raulb

Labels
blocked Not ready to ship
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@raulb @jayjayjpg