Skip to content

Commit 41128e6

Browse files
authored
{Doc} Refine bump version doc (#31087)
1 parent 6a9d71a commit 41128e6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/how_to_bump_SDK_version_in_cli.md

+5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This article aims to provide a guide for CLI developers and contributors to bump SDK version in Azure CLI.
44

5+
## Prerequisites
6+
7+
We assume the [swagger](https://github.com/Azure/azure-rest-api-specs) has been updated and the related Python SDK has been generated.
8+
59
## Overview
610

711
Developers need to do several things for bumping version:
@@ -52,6 +56,7 @@ For scenario b, variables `PACKAGE`, `TARGET_PACKAGE_VERSION`, `RESOURCE_TYPE` a
5256
- TARGET_PACKAGE_VERSION: The SDK new version, e.g., `19.3.0`. **Required for scenario b**. Leave it as empty for scenario a.
5357
- RESOURCE_TYPE: The resource type enum name define in [CLI Core](https://github.com/Azure/azure-cli/blob/ce74ae358b51aedfdfb6c32042b515d949618e33/src/azure-cli-core/azure/cli/core/profiles/_shared.py#L38), e.g., `MGMT_NETWORK`. Required if you want to update the API version definition in CLI Core. Usually used for multi-API SDKs. Leave it as empty for scenario a.
5458
- TARGET_API_VERSION: The new API version(s):
59+
- Leave this variable as empty if the SDK contains single target API version, else
5560
- If the AZURE_API_PROFILES['latest'][RESOURCE_TYPE] definition is `str` type, then just fulfill this variable with new API version. For example, to update API version for [ResourceType.MGMT_NETWORK](https://github.com/Azure/azure-cli/blob/ce74ae358b51aedfdfb6c32042b515d949618e33/src/azure-cli-core/azure/cli/core/profiles/_shared.py#L150), use `2021-10-01` as variable value.
5661
- If the AZURE_API_PROFILES['latest'][RESOURCE_TYPE] definition is `SDKProfile` type, then fulfill this variable with 'operation=version' pairs separated by space. For example, to update API version for [ResourceType.MGMT_COMPUTE](https://github.com/Azure/azure-cli/blob/ce74ae358b51aedfdfb6c32042b515d949618e33/src/azure-cli-core/azure/cli/core/profiles/_shared.py#L151-L164), use `default=2022-05-01 snapshots=2022-03-01 gallery_images=2021-12-01` as variable value. `default` means other operations except for explicitly listed ones.
5762

0 commit comments

Comments
 (0)