From 54ea130a341c87042af44abd24d11ee174348582 Mon Sep 17 00:00:00 2001 From: Zhenglai Zhang Date: Thu, 29 Oct 2020 16:55:03 +0800 Subject: [PATCH 1/4] update pr template to include changelog section --- .github/PULL_REQUEST_TEMPLATE.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cc4fa7417dcd..7e17de4fa823 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,27 @@ MSFT employees can try out our new experience at [OpenAPI Hub](https://aka.ms/openapiportal) - one location for using our validation tools and finding your workflow. +### Changelog +Please ensure to add changelog with this PR by answering the following questions. + 1. What's the purpose of the update? + - [ ] new service onboarding + - [ ] new API version + - [ ] update existing version for new feature + - [ ] update existing version to fix swagger quality issue in s360 + - [ ] Other, please clarify + 2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet. + 3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. + 4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published. + - [ ] SDK of .NET (need service team to ensure code readiness) + - [ ] SDK of Python + - [ ] SDK of Java + - [ ] SDK of Js + - [ ] SDK of Go + - [ ] PowerShell + - [ ] CLI + - [ ] Terraform + - [ ] No, no need to refresh for updates in this PR + ### Contribution checklist: - [ ] 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. From 95adf6aed3c8fcb13e6ba5d49f6e058f5bb5990c Mon Sep 17 00:00:00 2001 From: Zhenglai Zhang Date: Fri, 6 Nov 2020 16:25:08 +0800 Subject: [PATCH 2/4] add breaking change evaluation process doc --- .github/PULL_REQUEST_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7e17de4fa823..2eb516291f74 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -48,4 +48,6 @@ If there are following updates in the PR, ensure to request an approval from API - [ ] Updating API in stable version with Breaking Change Validation errors - [ ] Updating API(s) in preview over 1 year +Note: To initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://msazure.visualstudio.com/One/_workitems/create/Scenario?templateId=d1c215ec-5d6a-4cb3-a193-95ddd0a1ba96&ownerId=85bb92fb-21fe-41ca-9309-47f2c5f57515). Addition details on the process and office hours are on the [Breaking change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes). + Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview). \ No newline at end of file From 46931c63ea55a23fd60f035face131f8dcc56a1d Mon Sep 17 00:00:00 2001 From: Zhenglai Zhang Date: Fri, 6 Nov 2020 16:31:32 +0800 Subject: [PATCH 3/4] add breaking change evaluation process for workflow bot --- .github/comment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/comment.yml b/.github/comment.yml index 1b7f5ae5aaaf..f6ef948d8928 100644 --- a/.github/comment.yml +++ b/.github/comment.yml @@ -17,7 +17,7 @@ - rule: type: label label: BreakingChangeReviewRequired - onLabeledComments: "Hi @${PRAuthor}, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow [breaking change policy](https://aka.ms/AzBreakingChangesPolicy) to request breaking change review and approval before proceeding swagger PR review.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback. " + onLabeledComments: "Hi @${PRAuthor}, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow [breaking change policy](https://aka.ms/AzBreakingChangesPolicy) to request breaking change review and approval before proceeding swagger PR review.
**Action**: To initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://msazure.visualstudio.com/One/_workitems/create/Scenario?templateId=d1c215ec-5d6a-4cb3-a193-95ddd0a1ba96&ownerId=85bb92fb-21fe-41ca-9309-47f2c5f57515). Addition details on the process and office hours are on the [Breaking change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes).
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback." - rule: type: label From 8977906163733df501250812b985c0fba6bfd3d5 Mon Sep 17 00:00:00 2001 From: Zhenglai Zhang Date: Fri, 6 Nov 2020 17:11:40 +0800 Subject: [PATCH 4/4] improve wording --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2eb516291f74..b2ab132453a0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -48,6 +48,6 @@ If there are following updates in the PR, ensure to request an approval from API - [ ] Updating API in stable version with Breaking Change Validation errors - [ ] Updating API(s) in preview over 1 year -Note: To initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://msazure.visualstudio.com/One/_workitems/create/Scenario?templateId=d1c215ec-5d6a-4cb3-a193-95ddd0a1ba96&ownerId=85bb92fb-21fe-41ca-9309-47f2c5f57515). Addition details on the process and office hours are on the [Breaking change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes). +To initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://msazure.visualstudio.com/One/_workitems/create/Scenario?templateId=d1c215ec-5d6a-4cb3-a193-95ddd0a1ba96&ownerId=85bb92fb-21fe-41ca-9309-47f2c5f57515). Addition details on the process and office hours are on the [Breaking change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes). Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview). \ No newline at end of file