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

Deprecate functionality that is now in imgpkg #92

Closed
joaopapereira opened this issue Jan 15, 2021 · 5 comments
Closed

Deprecate functionality that is now in imgpkg #92

joaopapereira opened this issue Jan 15, 2021 · 5 comments
Assignees
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request

Comments

@joaopapereira
Copy link
Member

joaopapereira commented Jan 15, 2021

Describe the problem/challenge you have
Some of the functionality that already is part of imgpkg should be deprecated from kbld

Describe the solution you'd like
Scenario 1:

Given I have kbld installed
When I execute kbld --help
Then I should not see reference to relocate, package or unpackage

Scenario 2:

Given I have kbld installed
When I execute kbld relocate --help
Then I should see

Command "relocate" is deprecated, please use 'imgpkg copy', learn more in https://carvel.dev/imgpkg/docs/latest/commands/#copy

Scenario 3:

Given I have kbld installed
When I execute kbld package --help
Then I should see

Command "package" is deprecated, please use 'imgpkg push', learn more in https://carvel.dev/imgpkg/docs/latest/commands/#push

Scenario 4:

Given I have kbld installed
When I execute kbld unpackage --help
Then I should see

Command "unpackage" is deprecated, please use 'imgpkg pull', learn more in https://carvel.dev/imgpkg/docs/latest/commands/#pull

Scenario 5:

Given I access https://carvel.dev/kbld
When I click on the Packaging & Relocation link
Then I should see

Packaging and Relocation

This functionality was deprecated in `kbld` and will be removed in the near future. Check the new tool [imgpkg](https://carvel.dev/imgpkg).

Anything else you would like to add:
In this initial story, we should hide the commands and in the future remove them

@joaopapereira joaopapereira added enhancement This issue is a feature request carvel triage This issue has not yet been reviewed for validity labels Jan 15, 2021
@cppforlife
Copy link
Contributor

i wonder if it's also worth hiding pkg/unpkg/relocate commands from kbld -h? if not then may be also adding [deprecated] prefix to command description.

@danielhelfand
Copy link
Contributor

I am wondering if it would be worthwhile to write a message to stderr with a deprecation warning. Maybe also mentioning imgpkg docs in the message. This would be in addition to hiding the commands from help.

Do we have any recommended time line for fully removing commands from other Carvel tools?

@danielhelfand danielhelfand added carvel accepted This issue should be considered for future work and that the triage process has been completed and removed carvel triage This issue has not yet been reviewed for validity labels Jan 20, 2021
@joaopapereira
Copy link
Member Author

joaopapereira commented Jan 20, 2021

I am wondering if it would be worthwhile to write a message to stderr with a deprecation warning. Maybe also mentioning imgpkg docs in the message. This would be in addition to hiding the commands from help.

Hmmm, I think we get that for free if we set the cobra command as deprecated, using the deprecated field in the struct. But it is good to ensure that.

Do we have any recommended time line for fully removing commands from other Carvel tools?

According to our release process document, we say 3 minor releases but we did not have a major discussion to understand if this timing makes sense to our type of tools that are more long living

@joaopapereira
Copy link
Member Author

Fixed in both PRs associated

@joaopapereira
Copy link
Member Author

This will be released on version v0.30.0

@github-actions github-actions bot added the carvel triage This issue has not yet been reviewed for validity label Mar 9, 2021
@joaopapereira joaopapereira removed the carvel triage This issue has not yet been reviewed for validity label Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request
Projects
None yet
Development

No branches or pull requests

3 participants