diff --git a/documentation/release-request/comments.png b/documentation/release-request/comments.png new file mode 100644 index 000000000000..58a7a693cc4d Binary files /dev/null and b/documentation/release-request/comments.png differ diff --git a/documentation/release-request/default-tag.png b/documentation/release-request/default-tag.png new file mode 100644 index 000000000000..44a6c11f0c5e Binary files /dev/null and b/documentation/release-request/default-tag.png differ diff --git a/documentation/release-request/expected-release-date.png b/documentation/release-request/expected-release-date.png new file mode 100644 index 000000000000..623dc22eb155 Binary files /dev/null and b/documentation/release-request/expected-release-date.png differ diff --git a/documentation/release-request/link.png b/documentation/release-request/link.png new file mode 100644 index 000000000000..9d15f426b64a Binary files /dev/null and b/documentation/release-request/link.png differ diff --git a/documentation/release-request/rules-for-release-request.md b/documentation/release-request/rules-for-release-request.md new file mode 100644 index 000000000000..e3089f745a2d --- /dev/null +++ b/documentation/release-request/rules-for-release-request.md @@ -0,0 +1,46 @@ +This file claims some rules for those who want official SDK release. + +# How to ask for official SDK +Kake release request in [website](https://portal.azure-devex-tools.com/tools/request-api-release) + +# Some guidance and rules when you fill the release issue + +### 1. Expected release date for SDKs (PST) +![img.png](expected-release-date.png) + +SDK team need some time to prepare and test, so it is better to leave at least 1 week for them. + +### 2. Link to PR or spec (if PR unavailable) +![img.png](link.png) + +Two kinds of link is supported: + +(1) PR link(for example: https://github.com/Azure/azure-rest-api-specs/pull/16554). If the PR contains `several kinds` of +services, please paste specific service definition link(for example: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager) +in `Comments` to clarify which is needed. + +(2) service definition link(for example: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager) + +Note: `make sure` the content you want is `merged` into [main repo: azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs). +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). + +### 3. ReadMe tag to be released +![img.png](tag.png) + +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) +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 +release request. + +![img.png](default-tag.png) + +### 4. Comments +![img.png](comments.png) + +If anything needs to clarify, write it in `Comments` + +# What need to do after making release request + +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), +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, +they will paste the link and close the issue. + diff --git a/documentation/release-request/tag.png b/documentation/release-request/tag.png new file mode 100644 index 000000000000..d915ce8ab8fa Binary files /dev/null and b/documentation/release-request/tag.png differ