Skip to content

Cleanup multiapi package generation (along with doc refs). #41943

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 10, 2025
Merged

Cleanup multiapi package generation (along with doc refs). #41943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c93bfb6
cleanup multiapi package generation (along with doc refs).
scbedd Jul 8, 2025
1be7be4
fix the spelling errors in the doc I changed
scbedd Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions doc/dev/mgmt/cheatsheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,6 @@ python ./scripts/dev_setup.py -p $PACKAGE
python -m packaging_tools.generate_sdk -v -m restapi_path/readme.md
```

Regenerate multi-api client:<br/>
`python ./scripts/multiapi_init_gen.py azure-mgmt-myservice`

Regenerate multi-api of multi-client package:<br/>
`python ./scripts/multiapi_init_gen.py azure-mgmt-myservice#subclientname`

## Update packaging setup.py / MANIFEST / etc.

Locally:<br/>
Expand All @@ -50,7 +44,7 @@ Locally:<br/>
Update a given PR (needs GH_TOKEN env variable set):<br/>
`python -m packaging_tools.update_pr -v -p 3979`

Edit `sdk_packaging.toml` if necesseray and restart the tool.
Edit `sdk_packaging.toml` if necessary and restart the tool.

Available options:

Expand All @@ -61,7 +55,7 @@ Available options:
| package_nspkg | str | namespace package name | azure-mgmt-nspkg |
| package_pprint_name | str | The nice name to show on PyPI | MyService Management |
| package_doc_id | str | the moniker on docs.microsoft.com (could be empty) | my-service |
| is_stable | bool | Should have discriminer as stable | false |
| is_stable | bool | Should have discriminator as stable | false |
| is_arm | bool | needs a dependency on msrestazure | true |

## ChangeLog
Expand Down
7 changes: 2 additions & 5 deletions doc/dev/package_version/package_version_rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ If Python SDK contains preview api-version (like "2020-01-01-preview"), its vers
(1) For single-api package(for example: [confidentialledger](https://github.com/azure-sdk/azure-sdk-for-python/blob/a56c4b44911e173a89cb051aefc588e189e42654/sdk/confidentialledger/azure-mgmt-confidentialledger/azure/mgmt/confidentialledger/_configuration.py#L39)),
as long as it contains preview api-version, the package version should be preview

(2) For multi-api package(for example: [network](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/network/azure-mgmt-network)),
there will be `DEFAULT_API_VERSION`(for example: [`DEFAULT_API_VERSION` of network](https://github.com/Azure/azure-sdk-for-python/blob/0b3fb9ef0bee54f23beb7a4913faaaef5be90d9b/sdk/network/azure-mgmt-network/azure/mgmt/network/_network_management_client.py#L57)).
(2) For multi-api package(for example: [network](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/network/azure-mgmt-network)),
there will be `DEFAULT_API_VERSION`(for example: [`DEFAULT_API_VERSION` of network](https://github.com/Azure/azure-sdk-for-python/blob/0b3fb9ef0bee54f23beb7a4913faaaef5be90d9b/sdk/network/azure-mgmt-network/azure/mgmt/network/_network_management_client.py#L57)).
As long as it is preview, then the package version is preview.

(note1: For more info about multi-api package, please refer to [multiapi.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/multiapi.md))

(note2: preview package version contains `b`, for example: `1.0.0b1`)

# How to calculate next package version
Expand All @@ -40,4 +38,3 @@ According to the up rules, we could summarize all the possibilities in the follo
![img.png](version_summary.png)

(`-` means that this item doesn't influence result)

Loading
Loading