Skip to content

Commit 230afcf

Browse files
authored
Dataplane autogeneration (Azure#12210)
* SwaggerToSdk configuration file Track1 * Add Github CLI to doc
1 parent ace79c0 commit 230afcf

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

doc/dev/mgmt/mgmt_release.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,22 @@ Once you have a PR that contains accurate with correct tests (or no tests at all
1818

1919
IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](../dev_setup.md) in your currently loaded virtual environment.
2020

21+
## Manual generation
22+
23+
If the automation is not doing its job to create an auto PR, Python has a SwaggerToSdk CLI that can be used to generate a specific Readme. You need
24+
a virtual environment loaded with at least `tools/azure-sdk-tools` installed.
25+
26+
```shell
27+
# Using default configuration (this can be a Github raw link)
28+
generate_sdk -v -m ..\azure-rest-api-specs\specification\compute\resource-manager\readme.md
29+
30+
# Forcing Track1 generation
31+
generate_sdk -v -c eng\swagger_to_sdk_config_track1.json -m ..\azure-rest-api-specs\specification\cognitiveservices\data-plane\Face\readme.md
32+
33+
# For more details about the available options
34+
generate_sdk --help
35+
```
36+
2137
## Building the packaging information
2238

2339
If the automation is doing its job correctly, there is a pipeline called "update PR" that is supposed to update the package on the branch.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"$schema": "https://openapistorageprod.blob.core.windows.net/sdkautomation/prod/schemas/swagger_to_sdk_config.schema.json",
3+
"meta": {
4+
"autorest_options": {
5+
"version": "V2",
6+
"use": "@microsoft.azure/autorest.python@~4.0.71",
7+
"python": "",
8+
"python-mode": "update",
9+
"sdkrel:python-sdks-folder": "./sdk/.",
10+
"multiapi": "",
11+
"keep-version-file" :"",
12+
"no-async": ""
13+
},
14+
"advanced_options": {
15+
"create_sdk_pull_requests": true,
16+
"sdk_generation_pull_request_base": "integration_branch"
17+
},
18+
"repotag": "azure-sdk-for-python",
19+
"version": "0.2.0"
20+
}
21+
}

0 commit comments

Comments
 (0)