-
Notifications
You must be signed in to change notification settings - Fork 42
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
Feature: Add interface to declare aliases for legacy actions #187
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ature/deprecated-action-aliases
…ature/deprecated-action-aliases
…ature/deprecated-action-aliases
artemii-yanushevskyi
requested changes
Jun 13, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems like we use "legacy" and "deprecated" interchangeably, can we perhaps stick to one or the other?
artemii-yanushevskyi
approved these changes
Jun 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At the moment there is no way to gracefully change tool namespace. For example the root namespace of
app-store-connect
is utterly cluttered and many of the actions could and should be grouped under relevant action groups.For example at the moment we have action
app-store-connect get-profile
. But as there are a lot more profile actions, then it would make sense to create a separate action groupprofiles
, and make theget-profile
action under that asapp-store-connect profiles get
. Just doing a hard rename would be a breaking change that we want to avoid at all cost.This PR adds option to add a deprecated alias via
deprecated_alias
parameter to@cli.action
decorator. By moving forwards with the example above, with the changes from this PR we can refactorfrom
AppStoreConnect
class toProfilesActionGroup
asThen both action
app-store-connect get-profile
andapp-store-connect profiles get
would do the same thing with the difference that the deprecated version does not pop up in--help
messages and yields a warning message: