Azure / iotedgedev

The Azure IoT Edge Dev Tool greatly simplifies your Azure IoT Edge development process. It has everything you need to get started and helps with your day-to-day Edge development.
https://aka.ms/iotedgedev
Other
160 stars 71 forks source link

Deprecate duplicate commands #574

Closed shiroyama closed 2 years ago

shiroyama commented 2 years ago

Checklist

This checklist is used to make sure that common guidelines for a pull request are followed.

General guidelines

Description

Some commands can be called in two different ways (for instance, iotedgedev init and iotedgev solution init). Eventually, this duplication should be removed to simplify the tool. This is a breaking change, though; so before implementing it in the next major release, we should add a deprecation notice in such commands. This deprecation notice should be added to the help message and printed when the command is run. This can be done by setting deprecated=True in the click.Command() decorator (see documentation).

Note that the reason for this duplication is that the commands are added to two click groups (main and solution). The commands that should be deprecated are the ones corresponding to the main group.

Fixes #559

Additional information

marianan commented 2 years ago

looked into the pipeline failures briefly, it may be that 'deprecated' library needs to be added into requirements.txt

shiroyama commented 2 years ago

@marianan My apologies, the deprecated was accidentally added to the import list. By removing it everything seems working. Now the pipeline is all green. It'd be really nice if you could take a look again! Cheers!