PR #187 added the possibility to rename CLI actions while retaining the old version as a deprecated alias. Changes in this PR here utilize this development to clear up app-store-connect namespace and group actions interacting with similar resources under action groups. Currently there is a mix of actions like get-reource, list-resources etc and action groups that gather actions for similar resources (apps, beta-groups) such as resources get, resources list etc.
Due to this discrepancy it is hard to add new actions for resources that already have some actions, but do not have their dedicated namespace / action group yet. For example, where to add action that modifies bundle identifiers - should it still go under the root namespace polluting the already messy scope, or should there be another action group for the new action, which would further confuse the command line API?
For now all but one standalone actions that are directly related to a App Store Connect resource were all related to bundle identifiers, certificates, devices or provisioning profiles. New action groups were introduced for those resources to gather all related actions under unified namespace.
[!IMPORTANT]
With all the refactorings carried out in this PR, the public Python API of codemagic.tools.AppStoreConnect remains unchanged.
Renamed actions:
app-store-connect list-builds -> app-store-connect builds list
app-store-connect get-profile -> app-store-connect profiles get
app-store-connect list-profiles -> app-store-connect profiles list
[!NOTE]
Functionality of old actions remains exactly the same with the caveat that invoking a deprecated action will show a warning message.
Examples with screenshots
Calling action with deprecated name
![Screenshot 2024-01-02 at 15 11 35](https://github.com/codemagic-ci-cd/cli-tools/assets/2756611/d8ebd8d7-bc91-413b-a6b6-d83d5e1525de)
Calling the same action with up-to-date name
![Screenshot 2024-01-02 at 15 11 51](https://github.com/codemagic-ci-cd/cli-tools/assets/2756611/c0a95052-ab41-472a-9b5e-9fc136b68973)
Changes to documentation were applied in a follow up PR #387.
PR #187 added the possibility to rename CLI actions while retaining the old version as a deprecated alias. Changes in this PR here utilize this development to clear up
app-store-connect
namespace and group actions interacting with similar resources under action groups. Currently there is a mix of actions likeget-reource
,list-resources
etc and action groups that gather actions for similar resources (apps
,beta-groups
) such asresources get
,resources list
etc.Due to this discrepancy it is hard to add new actions for resources that already have some actions, but do not have their dedicated namespace / action group yet. For example, where to add action that modifies bundle identifiers - should it still go under the root namespace polluting the already messy scope, or should there be another action group for the new action, which would further confuse the command line API?
For now all but one standalone actions that are directly related to a App Store Connect resource were all related to bundle identifiers, certificates, devices or provisioning profiles. New action groups were introduced for those resources to gather all related actions under unified namespace.
Renamed actions:
app-store-connect list-builds
->app-store-connect builds list
app-store-connect create-bundle-id
->app-store-connect bundle-ids create
app-store-connect delete-bundle-id
->app-store-connect bundle-ids delete
app-store-connect get-bundle-id
->app-store-connect bundle-ids get
app-store-connect list-bundle-id-profiles
->app-store-connect bundle-ids profiles
app-store-connect list-bundle-ids
->app-store-connect bundle-ids list
app-store-connect create-certificate
->app-store-connect certificates create
app-store-connect delete-certificate
->app-store-connect certificates delete
app-store-connect get-certificate
->app-store-connect certificates get
app-store-connect list-certificates
->app-store-connect certificates list
app-store-connect list-devices
->app-store-connect devices list
app-store-connect register-device
->app-store-connect devices register
app-store-connect create-profile
->app-store-connect profiles create
app-store-connect delete-profile
->app-store-connect profiles delete
app-store-connect get-profile
->app-store-connect profiles get
app-store-connect list-profiles
->app-store-connect profiles list
Examples with screenshots
Calling action with deprecated name
![Screenshot 2024-01-02 at 15 11 35](https://github.com/codemagic-ci-cd/cli-tools/assets/2756611/d8ebd8d7-bc91-413b-a6b6-d83d5e1525de)Calling the same action with up-to-date name
![Screenshot 2024-01-02 at 15 11 51](https://github.com/codemagic-ci-cd/cli-tools/assets/2756611/c0a95052-ab41-472a-9b5e-9fc136b68973)Changes to documentation were applied in a follow up PR #387.