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/dev/mgmt/mgmt_release.md
+22-25Lines changed: 22 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,16 @@
2
2
3
3
## General Release Process Overview
4
4
5
-
Once Swagger PR is merged, SDK automation will create pull request to Azure SDK for Python repository, and here are steps that you need to do in order to release a new package:
5
+
Once Swagger PR is merged and a release plan/request is submitted, here are steps that you need to do in order to release a new package:
6
6
7
-
-open PR that was merged in swagger repository and find the link to the PR createted in Azure SDK for Python
8
-
-reopen generated SDK PR and make sure the CI passes
7
+
-create SDK pull request with code generation
8
+
-identify and resolve breaking changes
9
9
- verify that generated code was generated correctly, make sure right version was generated with right configuration
10
+
- verify the release notes match actual changes (CHANGELOG.md)
11
+
- verify the version accordingly to changes that were made (_version.py)
12
+
- generate samples and develop tests
13
+
- make sure the CI passes
10
14
- merge the PR if everything looks good
11
-
- create another PR manually in order to add release notest and update version (this is currently not done by automation)
12
-
- generate release notes as described below, verify they match actual changes (HISTORY.rst)
13
-
- update version accordingly to changes that were made (version.py)
14
-
- merge the PR
15
15
- run release pipeline
16
16
17
17
Once you have a PR that contains accurate with correct tests (or no tests at all, but CI is green), this page explains how to prepare for a release.
@@ -20,8 +20,8 @@ IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_s
20
20
21
21
## Manual generation
22
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 `eng/tools/azure-sdk-tools` installed.
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 SDK by a specific Readme. You need
24
+
a virtual environment loaded with at least `eng/tools/azure-sdk-tools` installed. And to manually create a package from Typespec, here's the full direction https://github.com/Azure/azure-sdk-for-python/wiki/Generate-Python-Mgmt-SDK-from-Typespec.
25
25
26
26
```shell
27
27
# Using default configuration (this can be a Github raw link)
@@ -43,16 +43,16 @@ If not, you can execute this command (replace the last part by your package name
If the file sdk_packaging.toml didn't exist, now one is created with default values. Update this file and update the default values to the one from this service. Once it's done, restart the same script.
46
+
If the file pyproject.toml didn't exist, now one is created with default values. Update this file and update the default values to the one from this service. Once it's done, restart the same script.
47
47
48
48
Your packaging info are up-to-date
49
49
50
50
## Building the ChangeLog
51
51
52
-
For all packages, you need to update the `HISTORY.rst` file
52
+
For all packages, you need to update the `CHANGELOG.md` file
53
53
54
54
```
55
-
/azure-mgmt-myservice/HISTORY.rst
55
+
/azure-mgmt-myservice/CHANGELOG.md
56
56
```
57
57
58
58
For all **autorest generated packages**, there is a tool that allows you to auto-build the ChangeLog.
0 commit comments