|
1 | 1 | --- |
2 | | -- rule: |
3 | | - type: label |
4 | | - label: BreakingChangeReviewRequired |
5 | | - booleanFilterExpression: "!(Approved-OkToMerge)" |
6 | | - onLabeledComments: >- |
7 | | - Hi @${PRAuthor}! The automation detected breaking changes in this pull request. |
8 | | - As a result, it added the `BreakingChangeReviewRequired` label. |
9 | | - <br/><br/> |
10 | | - You cannot proceed with merging this PR until you complete one of the following action items: |
11 | | - <br/><br/> |
12 | | - **ACTION ITEM ALTERNATIVE A**: Fix the breaking change. <br/> |
13 | | - Please consult the documentation provided in the relevant validation failures. |
14 | | - <br/><br/> |
15 | | - **ACTION ITEM ALTERNATIVE B**: Request approval. <br/> |
16 | | - Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. |
17 | | - Please follow the process described in the |
18 | | - [High-level Breaking Change Process doc](https://aka.ms/breakingchangesprocess#high-level-breaking-change-process). |
19 | | - <br/><br/> |
20 | | - **ACTION ITEM ALTERNATIVE C**: Report false positive. <br/> |
21 | | - If you think there are no breaking changes, |
22 | | - i.e. the validation should pass yet it fails, |
23 | | - then please explain why in a PR comment and @ the PR assignee. |
24 | | -
|
25 | | -- rule: |
26 | | - type: label |
27 | | - label: NewApiVersionRequired |
28 | | - booleanFilterExpression: "!(Approved-OkToMerge)" |
29 | | - onLabeledComments: >- |
30 | | - Hi @${PRAuthor}! The automation detected this pull request introduces changes |
31 | | - to at least one existing API version that violate Azure's versioning policy. |
32 | | - To comply with the policy, these changes must be made in a new API version. |
33 | | - As a result, the automation added the `NewApiVersionRequired` label. |
34 | | - <br/><br/> |
35 | | - You cannot proceed with merging this PR until you complete one of the following action items: |
36 | | - <br/><br/> |
37 | | - **ACTION ITEM ALTERNATIVE A**: Introduce a new API version. <br/> |
38 | | - Submit a new PR instead of this one, or modify this PR, |
39 | | - so that it adds a new API version instead of introducing changes to existing API versions. |
40 | | - <br/><br/> |
41 | | - **ACTION ITEM ALTERNATIVE B**: Request approval. <br/> |
42 | | - Alternatively, if you cannot avoid modifying existing API versions, |
43 | | - then you can request an approval for them. |
44 | | - Please follow the process described in the |
45 | | - [High-level Breaking Change Process doc](https://aka.ms/breakingchangesprocess#high-level-breaking-change-process). |
46 | | - <br/><br/> |
47 | | - **ACTION ITEM ALTERNATIVE C**: Report false positive. <br/> |
48 | | - If you think there are no changes in existing API version, |
49 | | - i.e. there should be no `NewApiVersionRequired` label, |
50 | | - then please explain why in a PR comment and @ the PR assignee. |
51 | | - <br/><br/> |
52 | | - For additional guidance, please see https://aka.ms/NewApiVersionRequired |
53 | | -
|
54 | | -- rule: |
55 | | - type: label |
56 | | - label: SuppressionReviewRequired |
57 | | - onLabeledComments: "Hi @${PRAuthor}, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the [Swagger-Suppression-Process](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process) to get approval." |
58 | | - |
59 | 2 | - rule: |
60 | 3 | type: label |
61 | 4 | label: "CI-MissingBaseCommit" |
|
76 | 19 | label: Approved-OkToMerge |
77 | 20 | onLabeledComments: >- |
78 | 21 | Hi @${PRAuthor}! Your PR is approved. Congratulations. :partying_face::rocket: </br> |
79 | | - <li>If this PR is targeting 'main' branch, then it cannot be merged, as azure-rest-api-specs-pr repo 'main' branch is mirrored from azure-rest-api-specs 'main' branch. |
80 | | - If you want to publish the PR to the public repo (Azure/azure-rest-api-specs) 'main' branch, |
| 22 | + <li> |
| 23 | + If this PR is targeting `main` branch, then it cannot be merged, as `azure-rest-api-specs-pr` repo `main` branch |
| 24 | + is mirrored from `azure-rest-api-specs` `main`` branch. <br/> |
| 25 | + If you want to publish the PR to the public repo (`Azure/azure-rest-api-specs`) `main` branch, |
81 | 26 | please use [OpenAPIHub Publish PR](${openapiHub}/tools/publishpullrequest?pr=${owner}/${repo}/${PRNumber}&to=${to}). |
82 | | - </li> |
83 | | - <li>For further guidance on how to proceed please refer to this [wiki doc](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**). |
| 27 | + </li><li> |
| 28 | + For further guidance on how to proceed please refer to this |
| 29 | + [wiki article](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**). |
84 | 30 | </li> |
85 | 31 |
|
86 | 32 | - rule: |
|
98 | 44 | label: ArcReview |
99 | 45 | onLabeledComments: "Hi @${PRAuthor} and @arcboard, one or more change(s) have been detected in your Arc enabled VM's or Arc enabled Server's RPs. Please review the changes and ensure that no gaps have been introduced with respect to the ARM API modeling consistency across Azure Arc and Azure Compute. For further details, see guidelines at [Consistency in ARM Modeling](https://msazure.visualstudio.com/One/_wiki/wikis/One.wiki/377428/Consistency-in-ARM-Modeling?anchor=general-design-guidance). To approve the change(s), set the label to ArcSignedOff. If you have any questions, please mail to [email protected]." |
100 | 46 |
|
101 | | -- rule: |
102 | | - type: label |
103 | | - label: CI-FixRequiredOnFailure |
104 | | - onLabeledComments: >- |
105 | | - Hi @${PRAuthor}! Your PR has some issues. Please fix the CI issues, **if present**, in following order: `Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff`. |
106 | | - <br/> |
107 | | - <table><tr><th>Task</th><th>How to fix</th><th>Priority</th></tr> |
108 | | - <tr><td>Avocado</td><td>[Fix-Avocado](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#avocado)</td><td>High</td></tr> |
109 | | - <tr><td>Semantic Validation</td><td>[Fix-SemanticValidation-Error](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#semantic-validation)</td><td>High</td></tr> |
110 | | - <tr><td>Model Validation</td><td>[Fix-ModelValidation-Error](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#model-validation)</td><td>High</td></tr> |
111 | | - <tr><td>LintDiff</td><td>[Fix-LintDiff](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#lintdiff-validation)</td><td>High</td></tr></table> |
112 | | - <br/> |
113 | | - If you need further help, please reach out on the Teams channel [aka.ms/azsdk/support/specreview-channel](https://aka.ms/azsdk/support/specreview-channel). |
114 | | -
|
115 | 47 | - rule: |
116 | 48 | type: label |
117 | 49 | label: new-rp-namespace |
118 | 50 | onLabeledComments: "Hi, @${PRAuthor}, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved. </br> <b>Action Required</b>: <li> Follow this guidance [Naming for new initial management or client libraries (new SDKs) - Overview (azure.com)](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/821/Naming-for-new-initial-management-or-client-libraries-(new-SDKs)) to create an issue for management client library name arch board review. </li> <li>Paste the issue link that you created in step 1 in this PR</li> </br> <b> Impact</b>: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed." |
119 | 51 |
|
120 | | -- rule: |
121 | | - type: PROpen |
122 | | - variables: |
123 | | - openapiHub: https://aka.ms/openapihub |
124 | | - onOpenedComments: >- |
125 | | - Hi, @${PRAuthor}! Thank you for your pull request. To help get your PR merged:</br> |
126 | | - - Ensure you reviewed the checklists in the PR description. |
127 | | - - Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval. |
128 | | - - For convenient view of the API changes made by this PR, refer to the URLs provided in the table in |
129 | | - the `Generated ApiView` comment added to this PR. You can use ApiView to show API versions diff. |
130 | | -
|
131 | 52 | - rule: |
132 | 53 | type: checkbox |
133 | 54 | keywords: |
|
160 | 81 | type: label |
161 | 82 | label: ARMChangesRequested |
162 | 83 | onLabeledComments: >- |
163 | | - Please address or respond to feedback from the ARM API reviewer. |
164 | | - When you are ready to continue the ARM API review, please remove the `ARMChangesRequested` label. |
| 84 | + Please address or respond to feedback from the ARM API reviewer. <br/> |
| 85 | + When you are ready to continue the ARM API review, please remove the `ARMChangesRequested` label. <br/> |
165 | 86 | This will notify the reviewer to have another look. <br/> |
166 | 87 | If the feedback provided needs further discussion, please use this Teams channel to post your questions - |
167 | | - https://aka.ms/azsdk/support/specreview-channel. <br/> |
168 | | - Please indicate that this is an ARM-related question in the title of your post by including "[ARM Query]" |
169 | | - in the title. |
| 88 | + [aka.ms/azsdk/support/specreview-channel](https://aka.ms/azsdk/support/specreview-channel). <br/> |
| 89 | + Please include `[ARM Query]` in the title of your question to indicate that it is ARM-related. |
170 | 90 | onLabeledRemoveLabels: |
171 | 91 | - WaitForARMFeedback |
172 | 92 |
|
|
0 commit comments