Skip to content

Commit c24ee32

Browse files
authored
Guidance and rules for release request (Azure#16561)
* 0.1.0 * update * format
1 parent d5ccfc1 commit c24ee32

File tree

6 files changed

+46
-0
lines changed

6 files changed

+46
-0
lines changed
2.2 KB
Loading
16.9 KB
Loading
5.12 KB
Loading
3.49 KB
Loading
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
This file claims some rules for those who want official SDK release.
2+
3+
# How to ask for official SDK
4+
Kake release request in [website](https://portal.azure-devex-tools.com/tools/request-api-release)
5+
6+
# Some guidance and rules when you fill the release issue
7+
8+
### 1. Expected release date for SDKs (PST)
9+
![img.png](expected-release-date.png)
10+
11+
SDK team need some time to prepare and test, so it is better to leave at least 1 week for them.
12+
13+
### 2. Link to PR or spec (if PR unavailable)
14+
![img.png](link.png)
15+
16+
Two kinds of link is supported:
17+
18+
(1) PR link(for example: https://github.com/Azure/azure-rest-api-specs/pull/16554). If the PR contains `several kinds` of
19+
services, please paste specific service definition link(for example: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager)
20+
in `Comments` to clarify which is needed.
21+
22+
(2) service definition link(for example: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager)
23+
24+
Note: `make sure` the content you want is `merged` into [main repo: azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs).
25+
It is not permitted if PR is `open` or in [private repo: azure-rest-api-specs-pr](https://github.com/Azure/azure-rest-api-specs-pr).
26+
27+
### 3. ReadMe tag to be released
28+
![img.png](tag.png)
29+
30+
Make sure the tag is defined in `readme.md`(for example: https:https://github.com/Azure/azure-rest-api-specs/blob/main/specification/advisor/resource-manager/readme.md)
31+
and the tag should stay the same with `default tag` in `readme.md`. If not, please make a PR to modify it before make the
32+
release request.
33+
34+
![img.png](default-tag.png)
35+
36+
### 4. Comments
37+
![img.png](comments.png)
38+
39+
If anything needs to clarify, write it in `Comments`
40+
41+
# What need to do after making release request
42+
43+
You could find your issue in [Azure/sdk-release-request](https://github.com/Azure/sdk-release-request/issues?q=is%3Aopen+is%3Aissue+label%3AManagementPlane),
44+
please pay attention to the `comment of issue` since SDK team may `ask for confirmation` before `publish the official SDK`. Once the SDK is published,
45+
they will paste the link and close the issue.
46+
3.52 KB
Loading

0 commit comments

Comments
 (0)