diff --git a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md index 615c0d072e2c..a83864e937be 100644 --- a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md @@ -1,6 +1,10 @@ # ARM (Control Plane) API Specification Update Pull Request -> Tip: overwhelmed by all this guidance? See the `Getting help` section at the bottom of this PR description. +> [!TIP] +> Overwhelmed by all this guidance? See the `Getting help` section at the bottom of this PR description. + +> [!NOTE] +> As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review. ## PR review workflow diagram @@ -27,9 +31,7 @@ If the automation determines you have breaking changes, i.e. Step 1 from the dia ### ARM API changes review (Diagram Step 2) -- If this PR is in purview of ARM review then automation will add the `ARMReview` label. -- If you want to force ARM review, add the label yourself. -- Proceed according to the diagram at the top of this comment. +- For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review. @@ -38,21 +40,18 @@ If the automation determines you have breaking changes, i.e. Step 1 from the dia ### Diagram footnotes -[1] [ARM review queue] (for **merge** queues, see [2]) -The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page. -If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label `ARMChangesRequested` -is removed from your PR. This should cause the label `WaitForARMFeedback` to be added. -[2] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1]) - -If you need further help with anything, see `Getting help` section below. +[1] See [ARM review queue] (for **PR merge** queues, see [2]). +[2] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1]) +The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours. ## Purpose of this PR -What's the purpose of this PR? Check all that apply. This is **mandatory**! +What's the purpose of this PR? Check the specific option that applies. This is **mandatory**! - - [ ] New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using [OpenAPI Hub](https://aka.ms/openapihub)). + - [ ] New resource provider. + - [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using [OpenAPI Hub](https://aka.ms/openapihub)). - [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.) - [ ] Update existing version to fix swagger quality issues in S360. - [ ] Other, please clarify: @@ -93,11 +92,12 @@ to get approval. - To understand what you must do next to merge this PR, see the `Next Steps to Merge` comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. - For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix. +- For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review. - If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR. -[ARM review queue]: https://github.com/search?q=org%3AAzure+is%3Apr+is%3Aopen+label%3AWaitForARMFeedback+-label%3AIDCDevDiv++draft%3Afalse+sort%3Acreated-asc+&type=pullrequests +[ARM review queue]: https://aka.ms/azsdk/pr-arm-review#about-the-arm-review-queue [public repo merge queue]: https://github.com/Azure/azure-rest-api-specs/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+draft%3Afalse+sort%3Acreated-asc [private repo merge queue]: https://github.com/Azure/azure-rest-api-specs-pr/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+-label%3AApproved-OkToMerge+draft%3Afalse+sort%3Acreated-asc [breaking changes process]: https://eng.ms/docs/cloud-ai-platform/azure-core/azure-core-pm-and-design/trusted-platform-pm-karimb/service-lifecycle-and-actions-team/service-lifecycle-actions-team/apex/media/launchingproductbreakingchanges#breaking-change-process-1