From e069cf57bc8f4995db178950a4c9ee27fea20729 Mon Sep 17 00:00:00 2001 From: Zhenglai Zhang Date: Fri, 10 Jul 2020 16:56:22 +0800 Subject: [PATCH 1/2] update breaking change process in PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b8293d9af7b5..05bf7b002250 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,19 +2,27 @@ ### Contribution checklist: +- [ ] I commit to follow the [Breaking Change Policy](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/43942/Policy-for-Breaking-Changes) of “no breaking changes - [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow. - [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). ### ARM API Review Checklist -- [ ] Service team MUST add the "**WaitForARMFeedback**" label if the management plane API changes fall into one of the below categories. - - adding/removing APIs. - - adding/removing properties. - - adding/removing API-version. - - adding a new service in Azure. +- [ ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs. + - Adding new API(s) + - Adding a new API version + - Adding a new service -Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs. +Note all “removals” and “adding a new property” no more require ARM API review. -- [ ] If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them. -Please follow the link to find more details on [API review process](https://aka.ms/SwaggerPRReview). +- [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under Azure Resource Manager service) from IcM and reach out to them. + +### Breaking Change Review Checklist +If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the [Breaking Change Policy](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/43942/Policy-for-Breaking-Changes). + +- [ ] Removing API(s) in stable version +- [ ] Removing properties in stable version +- [ ] Removing API version(s) in stable version +- [ ] Updating API in stable version with Breaking Change Validation errors +- [ ] Updating API(s) in preview over 1 year From e30f609f17494dacabf982e4b7f2e9885c12c38e Mon Sep 17 00:00:00 2001 From: Zhenglai Zhang Date: Mon, 13 Jul 2020 13:24:40 +0800 Subject: [PATCH 2/2] update breaking change url --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 05bf7b002250..3c2cfcde11b6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,27 +2,27 @@ ### Contribution checklist: -- [ ] I commit to follow the [Breaking Change Policy](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/43942/Policy-for-Breaking-Changes) of “no breaking changes +- [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/bcforapi) of “no breaking changes - [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow. -- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) +- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and errors have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). ### ARM API Review Checklist -- [ ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs. +- [ ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review. - Adding new API(s) - Adding a new API version - Adding a new service -Note all “removals” and “adding a new property” no more require ARM API review. - - [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under Azure Resource Manager service) from IcM and reach out to them. ### Breaking Change Review Checklist -If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the [Breaking Change Policy](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/43942/Policy-for-Breaking-Changes). +If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi). - [ ] Removing API(s) in stable version - [ ] Removing properties in stable version - [ ] Removing API version(s) in stable version - [ ] Updating API in stable version with Breaking Change Validation errors - [ ] Updating API(s) in preview over 1 year + +Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview). \ No newline at end of file