You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/track_2_migration_guidance.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
Azure CLI is built on Azure Python SDKs. Recently, Azure Python SDK team announced the next generation product, named Track 2 SDK. The old version of SDK is called Track 1 SDK. It claims that it has some advantages than Track 1 SDK. It is not compatible with Track 1 SDK. A considerable number of work days are required for Azure CLI developers to migrate their modules from Track 1 SDK to Track 2 SDK. Let's see an example of Track 2 SDK. [azure-mgmt-compute 17.0.0b1](https://pypi.org/project/azure-mgmt-compute/17.0.0b1/) introduces important breaking changes and important new features like unified authentication and asynchronous programming.
4
4
5
-
This document summarizes typical issues and solutions when adopting Track 2 SDK in Azure CLI.
5
+
This document summarizes the steps to apply the changes for migration, typical changes when adopting Track 2 SDK in Azure CLI.
1. Upgrade the version of your SDK to track 2 SDK in [setup.py](https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/setup.py), [requirements.py3.Darwin.txt](https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/requirements.py3.Darwin.txt), [requirements.py3.Linux.txt](https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/requirements.py3.Linux.txt) and [requirements.py3.windows.txt](https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/requirements.py3.windows.txt).
18
+
2. Run command `azdev setup` to apply track 2 SDK to your local virtual environment.
19
+
3. Run style check with command `azdev style your_module_name` and fix the errors returned from the command.
20
+
4. Run linter check with command `azdev linter your_module_name` and fix the errors returned from the command.
21
+
5. Run tests with command `azdev test your_module_name --no-exitfirst` and fix the errors returned from the command.
22
+
6. Run tests lively with command `azdev test your_module_name --live --no-exitfirst` and fix the errors returned from the command.
23
+
7. Create the pull request for migration.
24
+
25
+
## Typical changes.
17
26
18
27
1.[Long running operation function name change](#long-running-operation-function-name-change)
0 commit comments